docs: add a CONTRIBUTING.md that references the dev docs#67
Open
agilgur5 wants to merge 1 commit intodocopt:masterfrom
Open
docs: add a CONTRIBUTING.md that references the dev docs#67agilgur5 wants to merge 1 commit intodocopt:masterfrom
CONTRIBUTING.md that references the dev docs#67agilgur5 wants to merge 1 commit intodocopt:masterfrom
Conversation
- `CONTRIBUTING.md` is a standard OSS convention - and GitHub recognizes when a `CONTRIBUTING.md` exists too and will add some buttons / prompts here and there - I looked for it initially when I started contributing and didn't see it, which was a bit confusing until I found `docs/developer.md` - just point to `docs/developer.md` as that describes things already - this just serves so people can find the dev docs more easily
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.
Summary
Add a standard
CONTRIBUTING.mdfile to the root that just referencesdocs/developer.mdfor better accessibilityDetails
CONTRIBUTING.mdis a standard OSS conventionCONTRIBUTING.mdexists too and will add some buttons / prompts here and theredocs/developer.mdjust point to
docs/developer.mdas that describes things already