bazelbuild/bazel

Documentation issue: FeatureConfiguration

Open

#11,323 opened on May 6, 2020

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Java (4,465 forks)batch import
P3help wantedteam-Documentationteam-Rules-CPPtype: documentation (cleanup)

Repository metrics

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

Description

Documentation URL: https://docs.bazel.build/versions/master/skylark/lib/FeatureConfiguration.html

This documentation is missing any kind of detail of what a feature actually is. Also has no context of what CROSSTOOL is, or what a CROSSTOOL feature is.

This should be written to explain what a FeatureConfiguration actually represents rather than referring to implicit knowledge of the historical context of what a CROSSTOOL file was and what was defined in it.

Contributor guide

Research direction
Rewrite the documentation page for FeatureConfiguration to explain what it represents without assuming knowledge of CROSSTOOL or its historical context.
Tech stack
None
Domain
documentation
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.
1-3 hours
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80