docs: add mandatory header workflow reminder to Licensing Rules#1078
Merged
Conversation
Motivation: Agents can miss the rule about not hand-writing license headers and accidentally paste the wrong header (e.g. the Akka-derived header for new code). Modification: Add a prominent blockquote reminder at the top of the Licensing Rules section that spells out the mandatory workflow: create file without header -> sbt headerCreateAll -> done. Result: Agents see the workflow before reading the detailed rules, reducing the chance of hand-writing an incorrect header. Tests: Not run - docs only References: None - process improvement
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
The existing Licensing Rules already state "Do not hand-write or invent license headers. Let sbt manage them" and "For new files, run
sbt headerCreateAll", but agents can still miss these rules and hand-write a header (e.g. accidentally using the Akka-derived header for new code).Modification
Add a prominent blockquote reminder at the top of the Licensing Rules section that spells out the mandatory workflow in one line: create file without header →
sbt headerCreateAll→ done.Result
Agents see the workflow before reading the detailed rules, reducing the chance of hand-writing an incorrect header.
Tests
Not run - docs only
References
None - process improvement