bazelbuild/bazel

configuration_field needs a warning not to use and a link to an example of using build settings

Open

#11,309 opened on May 6, 2020

View on GitHub
 (6 comments) (1 reaction) (0 assignees)Java (4,465 forks)batch import
P3help wantedteam-Configurabilityteam-Documentationtype: documentation (cleanup)

Repository metrics

Stars
 (25,384 stars)
PR merge metrics
 (Avg merge 22d 20h) (77 merged PRs in 30d)

Description

https://docs.bazel.build/versions/3.1.0/skylark/lib/globals.html#configuration_field

We need a longer example of use. It should be put in https://github.com/bazelbuild/examples/tree/master/rules with a link in the documentation (so that we can easily test and maintain the snippet).

Contributor guide

Research direction
Add a warning in the documentation for configuration field not to use it and link to an example in https://github.com/bazelbuild/examples/tree/master/rules.
Tech stack
None
Domain
documentationbuild system
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85