Add a CONTRIBUTING.md file, to appear on new Issue/PR pages #2837
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've just realized that if you create a file called
CONTRIBUTING.md
, a link to it will appear on the GitHub new Issue and new PR pages (https://github.com/blog/1184-contributing-guidelines).This seems like a good opportunity to provide some up-front tips on making contributions, and hopefully to improve the S/N on Issues.
I've drafted such a file here. Additions and suggestions are welcome (or can come in future PRs), but let's try to keep it succinct and to-the-point and with an obvious organization so that it gets read.
This should replace the bug reporting guide I created on the wiki (https://github.com/BVLC/caffe/wiki/Reporting-Bugs-and-Other-Issues), and probably also the recently added Contributing page by @BlGene (https://github.com/BVLC/caffe/wiki/Contributing), but it links to the more detailed contributing guide at http://caffe.berkeleyvision.org/development.html (which could stand a bit of reorganization).