feat: adds contributing markdown #75
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
Adds the CONTRIBUTING.md file to the repo. Includes a Quick Start guide on how to set up the repo, install dependencies, and go through the rest of the setup. Includes Development Guidelines with a link to the STYLE_GUIDE.md
Updated instructions for cloning the repo and branch naming conventions. Signed-off-by: Sophia Chang <103406603+soramicha@users.noreply.github.com>
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.
Closes #68
Overview
Adds the CONTRIBUTING.md file to the repo. Includes a Quick Start guide on how to set up the repo, install dependencies, and go through the rest of the setup. Includes Development Guidelines with a link to the STYLE_GUIDE.md
Testing
No testing
Screenshots / Screencasts
Preview of the markdown file (it's 3 pictures, sorry for the formatting):
Checklist
Tip: You can make the issue and then check them after the fact or replace
[ ]with[x]to check it!Notes
Not sure if the STYLE_GUIDE.md is supposed to be incorporated into the CONTRIBUTING.md file or if just linking it is sufficient. Also, much of the content was taken from this repo's README.md and Cal Poly's H4I repo, so let me know if something doesn't make sense or conform to Operation's standards.