docs: add a contributing guide - #93
Merged
Merged
Conversation
Covers the code of conduct, filing an issue, dev setup, the `make check` pre-flight, the converter's golden-file suite and the --json schema, commit conventions, and the rule that anything touching Confluence reads docs/confluence/ first and writes new findings back there. Trim README's Development section to the three commands worth having inline and point the rest at CONTRIBUTING.md, rather than keeping two copies of the task list that `make` already prints.
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
1 participant
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.
Adds a
CONTRIBUTING.md: code of conduct, filing an issue, dev setup, themake checkpre-flight, the converter golden-file suite and the--jsonschema as the two things a change can silently break, commit conventions, and the rule that anything touching Confluence readsdocs/confluence/first and writes new findings back there with how they were verified.README's Development section keeps the three commands worth having inline (
build,test,check) plus the.envnote, and points the rest at the new file. The per-target list it used to carry is whatmakewith no target already prints, andmake checkcovers the ones you actually need before a PR.