Core/grin
0
0
Fork 0
mirror of https://github.com/mimblewimble/grin.git synced 2025-05-11 19:51:18 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

updating contribution guidelines with info on how to submit documentation changes

Browse source
This commit is contained in:
Yeastplume 2017-11-07 21:45:52 +00:00
parent 1eeb1fae22
commit 4b9b74876e
1 changed files with 3 additions and 1 deletions

4
CONTRIBUTING.md
View file

@ -4,7 +4,9 @@ Find an area you can help with and do it. Open source is about collaboration and
The [list of issues](https://github.com/mimblewimble/grin/issues) is a good place to start, especially the ones tagged as "help wanted" (but don't let that stop you from looking at others). If you're looking for additional ideas, the code includes `TODO` comments for minor to major improvements. Grep is your friend.
Additional tests are rewarded with an immense amount of positive karma. So is documentation.
Additional tests are rewarded with an immense amount of positive karma.
More documentation or updates/fixes to existing documentation are also very welcome. However, if submitting a PR consisting of documentation changes only, please try to ensure that the change is significantly more substantial than one or two lines. For example, working through an install document and making changes and updates throughout as you find issues is worth a PR. For typos and other small changes, either contact one of the developers, or if you think it's a significant enough error to cause problems for other users, please feel free to open an issue.
Find us: