Repository navigation
chore: add contribution and repository governance guidelines - #19
Merged
Merged
Conversation
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
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.
Summary
@2dubu.Background
PaletteKit is receiving external contributions but did not yet document its review and testing expectations. In particular, bug-fix pull requests should explain the underlying failure mechanism and verify the relevant invariant rather than relying only on a reported attachment or a no-crash assertion.
Repository governance changes should also remain separate from package implementation work so they can be reviewed and tracked independently.
Solution
Introduce a small set of repository-level guidance:
CONTRIBUTING.mdcovering development requirements, test commands, root-cause regression testing, performance-sensitive changes, and API compatibility;Related Issue
N/A
Verification
git diff --checkwith no errors.Compatibility and Impact
Additional Context
This change does not require a package version bump, changelog entry, tag, or release. The PR template and CODEOWNERS rule take effect after this PR is merged into the default branch. The proposed
mainruleset and merge settings are GitHub repository settings and will be configured separately.Checklist