[ckan-dev] Move contributing to CONTRIBUTING file?

Sean Hammond sean.hammond at okfn.org
Thu Jan 17 10:25:59 UTC 2013


Hey, I noticed that github will integrate your contributing docs into
the new issue and new pull request pages, if you put them in a
CONTRIBUTING file in the root of the git repo:

https://github.com/blog/1184-contributing-guidelines

What do people think of moving docs.ckan.org/en/latest/contributing.html
to CONTRIBUTING?

Would make it a lot more prominent, currently buried at the bottom of
the (very long) docs, and it doesn't really belong in the user docs
anyway.

But I'm not sure what to do with the other developer pages (coding
standards etc.):

http://docs.ckan.org/en/latest/index.html#for-ckan-developers

Maybe they should each have a top-level file in the git repo but that
seems messy. Move to the wiki, and link to them from the CONTRIBUTING
file?




More information about the ckan-dev mailing list