Contributing to django CMS¶
Like every open-source project, django CMS is always looking for motivated individuals to contribute to its source code.
There’s more guidance on how to contribute in our documentation.
If you think you have discovered a security issue in our code, please report it privately, by emailing us at email@example.com.
Please do not raise it on:
- either of our email lists
or in any other public forum until we have had a chance to deal with it.
People interested in developing for the django CMS should join the django-cms-developers mailing list as well as heading over to #django-cms on the freenode IRC network for help and to discuss the development.
In a nutshell¶
Here’s what the contribution process looks like, in a bullet-points fashion, and only for the stuff we host on GitHub:
- django CMS is hosted on GitHub, at https://github.com/divio/django-cms
- The best method to contribute back is to create an account there, then fork the project. You can use this fork as if it was your own project, and should push your changes to it.
- When you feel your code is good enough for inclusion, “send us a pull request”, by using the nice GitHub web interface.
Getting the source code¶
If you’re interested in developing a new feature for the CMS, it is recommended that you first discuss it on the django-cms-developers mailing list so as not to do any work that will not get merged in anyway.
- Code will be reviewed and tested by at least one core developer, preferably by several. Other community members are welcome to give feedback.
- Code must be tested. Your pull request should include unit-tests (that cover the piece of code you’re submitting, obviously)
- Documentation should reflect your changes if relevant. There is nothing worse than invalid documentation.
- Usually, if unit tests are written, pass, and your change is relevant, then it’ll be merged.
Since we’re hosted on GitHub, django CMS uses git as a version control system.
The GitHub help is very well written and will get you started on using git and GitHub in a jiffy. It is an invaluable resource for newbies and old timers alike.
Syntax and conventions¶
We try to conform to PEP8 as much as possible. A few highlights:
- Indentation should be exactly 4 spaces. Not 2, not 6, not 8. 4. Also, tabs are evil.
- We try (loosely) to keep the line length at 79 characters. Generally the rule is “it should look good in a terminal-base editor” (eg vim), but we try not be [Godwin’s law] about it.
As of django CMS 3.1, we will use spaces within frontend code, not tabs as previously. In the meantime, please continue using tabs - all tabs will be converted to spaces in a single commit for 3.1.
Frontend code should be formatted for readability. If in doubt, follow existing examples, or ask.
This is how you fix a bug or add a feature:
- fork us on GitHub.
- Checkout your fork.
- Hack hack hack, test test test, commit commit commit, test again.
- Push to your fork.
- Open a pull request.
And at any point in that process, you can add: discuss discuss discuss, because it’s always useful for everyone to pass ideas around and look at things together.
Running and writing tests is really important: a pull request that lowers our testing coverage will only be accepted with a very good reason; bug-fixing patches must demonstrate the bug with a test to avoid regressions and to check that the fix works.
We have an IRC channel, our django-cms-developers email list, and of course the code reviews mechanism on GitHub - do use them.
Perhaps considered “boring” by hard-core coders, documentation is sometimes even more important than code! This is what brings fresh blood to a project, and serves as a reference for old timers. On top of this, documentation is the one area where less technical people can help most - you just need to write simple, unfussy English. Elegance of style is a secondary consideration, and your prose can be improved later if necessary.
Documentation should be:
- written using valid Sphinx/restructuredText syntax (see below for specifics) and the file extension should be .rst
- written in English (we have standardised on British spellings)
- accessible - you should assume the reader to be moderately familiar with Python and Django, but not anything else. Link to documentation of libraries you use, for example, even if they are “obvious” to you
- wrapped at 100 characters per line
Merging documentation is pretty fast and painless.
Also, contributing to the documentation will earn you great respect from the core developers. You get good karma just like a test contributor, but you get double cookie points. Seriously. You rock.
Except for the tiniest of change, we recommend that you test them before submitting. Follow the same steps above to fork and clone the project locally. Next, create a virtualenv so you can install the documentation tools:
virtualenv djcms-docs-env source djcms-docs-env/bin/activate pip install sphinx sphinx_rtd_theme
Now you can cd into the django-cms/docs directory and build the documentation:
make html open build/html/index.html
This allows you to review your changes in your local browser. After each change, be sure to rebuild the docs using make html. If everything looks good, then it’s time to push your changes to Github and open a pull request.
Our documentation is divided into the following main sections:
- Tutorials (introduction): step-by-step tutorials to get you up and running
- How-to guides (how_to): guides covering more advanced development
- Key topics (topics): explanations of key parts of the system
- Reference (reference): technical reference for APIs, key models and so on
- Development & community (contributing)
- Release notes & upgrade information (upgrade)
- (in progress Using django CMS (user): guides for using rather than setting up or developing for the CMS
We use Python documentation conventions for section marking:
- # with overline, for parts
- * with overline, for chapters
- =, for sections
- -, for subsections
- ^, for subsubsections
- ", for paragraphs
- use backticks - ``settings.py`` - for:
- names of fields and other items in the Admin interface:
- use emphasis - *Home* around:
- the names of available options in the Admin
- values in or of fields
- use strong emphasis - **Add page** around:
- buttons that perform an action
Rules for using technical words¶
There should be one consistent way of rendering any technical word, depending on its context. Please follow these rules:
- in general use, simply use the word as if it were any ordinary word, with no capitalisation or highlighting: “Your placeholder can now be used.”
- at the start of sentences or titles, capitalise in the usual way: “Placeholder management guide”
- when introducing the term for the the first time, or for the first time in a document, you may highlight it to draw attention to it: “Placeholders are special model fields”.
- when the word refers specifically to an object in the code, highlight it as a literal: “Placeholder methods can be overwritten as required” - when appropriate, link the term to further reference documentation as well as simply highlighting it.
Use absolute links to other documentation pages - :doc:`/how_to/toolbar` - rather than relative links - :doc:`/../toolbar`. This makes it easier to run search-and-replaces when items are moved in the structure.
For translators we have a Transifex account where you can translate the .po files and don’t need to install git or mercurial to be able to contribute. All changes there will be automatically sent to the project.
Top translations django-cms core: