AGENTS.md: use the Recoil engine file header for new files#3048
Open
tomjn wants to merge 1 commit into
Open
Conversation
The File Headers section recommended the legacy "Spring engine" header. New files should use the "Recoil engine" header (already used by a number of files in the tree). Note that existing "Spring engine" headers (Recoil is a fork of Spring) do not need a mass migration. Assisted by Claude Code.
Collaborator
|
The actual rule is to follow the copyright and state who authored the code. A "new" file still has to say Spring if existing Spring code was just moved there as part of a refactor. Conversely, if an existing file is completely rewritten it can reflect that in the licence notice and say Recoil. |
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.
What
Updates the File Headers section of
AGENTS.mdto recommend theRecoil enginelicense header for new files, instead of the legacySpring engineone:Also adds a note that existing
Spring engineheaders (Recoil is a fork of Spring) do not need a mass migration — this is guidance for new files only.Why
A number of files in the tree already use the
Recoil engineheader, and it came up in review that new files should follow that convention rather than the documentedSpring engineone. This aligns the doc with the intended convention.Assisted by Claude Code.