docs(repo): replace outdated CONTRIBUTING.md with HACKING.md#11
Merged
docs(repo): replace outdated CONTRIBUTING.md with HACKING.md#11
Conversation
- rename CONTRIBUTING.md -> HACKING.md - remove outdated instructions - add current development guidance
jdhoffa
changed the title
AlexAxthelm
approved these changes
Feb 23, 2026
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.
In light of recent conversations (taking place on Teams especially in the SPD&Friends channel), I came here intending to update our
CONTRIBUTING.mdto outline better guidance around the anticipated usage of AI.While I was there, I noticed a few things:
CONTRIBUTING.mdseemed to include mainly development guidance, but nothing around social expectations of opening a PR, and things like thatThis PR serves to bring that documentation up-to-date with relevant instructions.
A future PR will be opened with a new
CONTRIBUTING.mdfocused more on social aspects of contributing.Example
This is in line with other common open source projects, e.g.:
https://github.com/ghostty-org/ghostty/blob/main/CONTRIBUTING.md
https://github.com/ghostty-org/ghostty/blob/main/HACKING.md