[ckan-dev] CONTRIBUTING to CKAN and Coding Standards

Wed Apr 10 16:03:15 UTC 2013

Hey all,

Just a reminder that the CONTRIBUTING file in the root of CKAN's git
repo contains guidelines on how to contribute to CKAN, including links
to our various coding standards pages*, how to make a pull request, etc:

https://github.com/okfn/ckan/blob/master/CONTRIBUTING.rst

This also covers how to contribute to the docs.

* Our coding standards are unfortunately quite long (as we have to have
standards for Python, CSS, HTML, Javascript, docs..) so they're split
into multiple pages, but the contributing file should be the source file
that links to them all.

When you create a new issue on CKAN's github Issues, or make a new pull
request, github puts a link to the contributing file at the top of the
page:

https://github.com/okfn/ckan/issues/new

The CONTRIBUTING file also gets pulled into the Sphinx docs on docs.ckan.org:

http://docs.ckan.org/en/latest/contributing.html

This file should be unmissable by now! :)

If you're reviewing a pull request or writing code for CKAN and you come
across a "do" or "don't" that isn't documented yet, consider adding it
to the CKAN Code Architecture page (or other page as relevant) of the
coding standards and making a pull request. You'll find a link to this
page via the contributing file.