[openstack-dev] Add CONTRIBUTING file?

Daniel P. Berrange berrange at redhat.com
Wed Nov 21 17:43:41 UTC 2012


On Wed, Nov 21, 2012 at 09:26:53AM -0800, Monty Taylor wrote:
> Hey all!
> 
> When you go to add a new repo on github, you get this message:
> 
> "We recommend that every repository has a README, LICENSE,
> CONTRIBUTING, and .gitignore."
> 
> I certainly agree with them on 3 of the 4 - but I've never really
> thought about having a CONTRIBUTING file. It seems like a good idea
> though - especially since we have a kind-of specific workflow for
> contribution.
> 
> What do people think? Should we add that file? In it, should we
> include the text of our contribution instructions, or just a small
> snippet that directs people to the website with a quick 3-second
> "sign cla, download git-review, submit"?

For most projects I'm involved with this kind of info would
be either in the README file or the HACKING file. I don't
actually remember seeing use of a CONTRIBUTING file before.


Daniel
-- 
|: http://berrange.com      -o-    http://www.flickr.com/photos/dberrange/ :|
|: http://libvirt.org              -o-             http://virt-manager.org :|
|: http://autobuild.org       -o-         http://search.cpan.org/~danberr/ :|
|: http://entangle-photo.org       -o-       http://live.gnome.org/gtk-vnc :|



More information about the OpenStack-dev mailing list