Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Aug 2, 2015

Conversation

longjon
Copy link
Contributor

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

@lukeyeager
Copy link
Contributor

hopefully improve the S/N on Issues

👍

@ronghanghu
Copy link
Member

LGTM

@BlGene
Copy link
Contributor

BlGene commented Jul 31, 2015

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

@BlGene
Copy link
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.

@bhack
Copy link
Contributor

bhack commented Jul 31, 2015

@BlGene
Copy 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.

@seanbell
Copy link

seanbell commented Aug 1, 2015

👍

@longjon
Copy link
Contributor Author

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 added a commit that referenced this pull request Aug 2, 2015
Add a CONTRIBUTING.md file, to appear on new Issue/PR pages
@longjon longjon merged commit a6d79be into BVLC:master Aug 2, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants