bazel-contrib / bazel-contrib/buildtools
buildifier rule with check mode is deprecated but buildifier_test is not documented
- Dominant language
- Go
- Stars
- 1.2k
- Forks
- 471
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 13
Description
In the documentation only buildifier rule is explained
https://github.com/bazelbuild/buildtools/blob/master/buildifier/README.md#setup-and-usage-via-bazel-not-supported-on-windows
There is also no test in the buildtools repository that uses buildifier_test rule in order to check how it is to be used.
The only option is to dig in the implementation or into some PR / issue comments.
Contributor guide
Research direction
Start with the README.md section on setup and usage via Bazel, then inspect the buildifier_test rule implementation and the referenced PR or issue comments to establish its intended use. Add documentation for the rule and a buildtools repository test demonstrating that usage; done means a newcomer can follow the documented setup without reading implementation details.
Written by the indexing model from the issue text.
Assessment
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100