add CONTRIBUTING.md #292
Open
add CONTRIBUTING.md #292
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
|
Maybe add a link to mdBook documentation. https://rust-lang.github.io/mdBook/ |
I did. |
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.
I had some difficulty figuring out how to build anki-manual my first time and thought it'd be useful to include some instructions for others on how to build it locally, themselves.
I added a CONTRIBUTING.md file with local development instructions and linked to it in the README.md.
The CONTRIBUTING.md file could also probably benefit from some other information as well, such as what types of contributions are generally welcomed, but I thought this'd be a good start for now.
Let me know if there are any questions 👍