A contributing guide, since dev is already live - #153
Merged
Conversation
Signed-off-by: WaylandYang <wayland0916@gmail.com>
Merged
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.
There was no
CONTRIBUTINGfile, anddevplus its branch protection are already live. Rightnow someone arriving with a fix has nothing telling them where the PR goes.
Two files, matching the README convention:
CONTRIBUTING.mdandCONTRIBUTING.zh-CN.md,cross-linked.
What they cover, all of it specific to this repository rather than generic etiquette:
dev, PR with basedev, maintainers mergedevintomainontheir own schedule. Both branches protected.
UTOPIA_DATABASE_URL. The easiest thing to get wronghere: a green
cargo test --workspacedoes not mean everything ran, and what those testsguard (table aliases inside SQL strings,
NULLin comparisons, rows anINNER JOINdrops,recursive CTEs under diamond inheritance) is exactly what the compiler cannot see.
0011_has happened.Issue-first is required for anything touching the data model, the ontology contract or a public
API, with an ADR before code. Bug fixes, docs, i18n and tests go straight to a PR.