bazel-contrib / bazel-contrib/rules_scala
Phase Extension Convention
- Dominant language
- Starlark
- Stars
- 384
- Forks
- 292
- Avg merge
- 3d 3m
- Merged PRs (30d)
- 42
Description
Once we start writing more custom phase extensions to the repository, we need to set up a convention to follow. Rules like
- The name of phase `.bzl` file (e.g. `phase_scalafmt.bzl`)
- The name of extension `.bzl` file (e.g. `phase_scalafmt_ext.bzl`)
- The object names in extension file
- Extension object (e.g. `ext_scalafmt`)
- Rule to provide `ScalaRulePhase` (e.g. `scalafmt_singleton`)
Once we have agreements, I am happy to write it to a README.
Contributor guide
Research direction
Start by reviewing the phase and extension naming examples in the issue, including phase_scalafmt.bzl, phase_scalafmt_ext.bzl, ext_scalafmt, and scalafmt_singleton. Agree on the convention for these names, then record the decision in a README; done means the README documents the agreed rules clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100