Create a contributing guide #12
Open
+68
−0
Conversation
This file contains 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
dhzdhd
added
📄 type: documentation
Crimson-Blade
requested changes
Dec 17, 2022
| - Create a new branch as given in [naming a branch](#naming-a-branch) | ||
| - The dev setup is documented in the [README](README.md) | ||
| - Code the feature / bug fix / refactor | ||
| - Before pushing, execute all precommit hooks which includes linting and formatting. Fix all the issues that might arise from doing so. |
There was a problem hiding this comment.
This line is a little vague. Could you elaborate a little further?
There was a problem hiding this comment.
Yes, I should probably make it more general and leave the precommit hooks detail to the README.
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
Adds a CONTRIBUTING.md with two parts - basic and advanced.
Resolves #6