Add a CONTRIBUTING.md file, to appear on new Issue/PR pages #2837

Merged
merged 1 commit into from Aug 2, 2015

Conversation

Projects
None yet
6 participants
Contributor

longjon commented Jul 30, 2015

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).

Contributor

lukeyeager commented Jul 30, 2015

hopefully improve the S/N on Issues

👍

Member

ronghanghu commented Jul 31, 2015

LGTM

Contributor

BlGene commented Jul 31, 2015

👍 There do seem to be a lot of usage questions in issues.

Contributor

BlGene commented Jul 31, 2015

A Stackexchange (Area51) QA system might be a better long term solution if people are willing to give it a try.

The Area51 caffe QA website requires followers and questions with up votes, in order to migrate through the stages of: defined -> committed -> beta so any contribution is appreciated. As usual with these sites all control is based on reputation points earned.

Stack Exchange Q&A site proposal: caffe

@longjon @shelhamer @jeffdonahue @everyone
This would probably first require a mailinglist vs QA debate but if support can be found for this the CONTRIBUTING.md file might be a good place to put a link.

Contributor

BlGene commented Jul 31, 2015

@bhack
Yes, they got their own shiny custom site because they have enough users. In case you were suggesting it, having caffe questions on the opencv QA would not be a nice solution.

Contributor

seanbell commented Aug 1, 2015

👍

Contributor

longjon commented Aug 2, 2015

Okay, I'm going to go ahead and merge this pure-documentation update. Edits are welcome as PRs.

We've discussed setting up a QA style site (like OpenCV's or StackExchange) before, but probably don't have the bandwidth to manage that. If someone from the community wants to set that up, I think we'd be happy to link to/endorse it, and provide a (sub)domain name. Otherwise an actual StackExchange or the Caffe tag on StackOverflow are fine options as long as that fits with how StackExchange works, I don't really know.

@longjon longjon added a commit that referenced this pull request Aug 2, 2015

@longjon longjon Merge pull request #2837 from longjon/contributing-file
Add a CONTRIBUTING.md file, to appear on new Issue/PR pages
a6d79be

@longjon longjon merged commit a6d79be into BVLC:master Aug 2, 2015

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment