diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d8538efb..b62f5945 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ Find an area you can help with and do it. Open source is about collaboration and open participation. Try to make your code look like what already exists and submit a pull request. -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. +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. Use _Search in files_ in your code editor, or `grep "TODO" -r src/`. Additional tests are rewarded with an immense amount of positive karma. @@ -10,14 +10,15 @@ More documentation or updates/fixes to existing documentation are also very welc # Find Us -If any help is needed during your effort to contribute on this project, please don't hesitate to contact us: -* Chat: [Gitter](https://gitter.im/grin_community/Lobby). -* [Forum](https://www.grin-forum.org/) -* [Website](https://grin-tech.org) -* Mailing list: join the [~MimbleWimble team](https://launchpad.net/~mimblewimble) and subscribe on Launchpad. -* News: - * Twitter for the Grin council: [@grincouncil](https://twitter.com/grincouncil) - * Twitter bot that scrapes headlines, mailing list, and reddit posts related to MimbleWinble/Grin: [@grinmw](https://twitter.com/grinmw) +When you are starting to contribute to grin, we really would appreciate if you come by the gitter chat channels. + +In case of problems with trying out grin, before starting to contribute, there's the [Support chat](https://gitter.im/grin_community/support). Write there about what you've done, what you want to do, and maybe paste logs through a text paste webservice. + +* Please [join the grin Lobby](https://gitter.im/grin_community/Lobby) to get a feeling for the community. +* And [see the developers chat](https://gitter.im/grin_community/dev) if you have questions about source code files. + If you explain what you're looking at and what you want to do, we'll try to help you along the way. +* Also see `docs/*.md` and the folder structure explanations, and [the wiki](https://github.com/mimblewimble/docs/wiki). +* Further information and discussions are in the [Forum](https://www.grin-forum.org/), the [website](https://grin-tech.org), the [mailing list](https://lists.launchpad.net/mimblewimble/) and news channels like the [@grincouncil](https://twitter.com/grincouncil) and a (mostly unfiltered!) Twitter bot that collects headlines, mailing list posts, and reddit posts related to MimbleWinble/Grin: [@grinmw](https://twitter.com/grinmw) # Pull-Request Title Prefix @@ -41,7 +42,7 @@ Grin uses `rustfmt` to maintain consistent formatting, and we're using the git c ## Install rustfmt -You should use rustup. See [build docs](doc/build.md) for more info. +You should use `rustup`. See [build docs](doc/build.md) for more info. ``` rustup component add rustfmt-preview