Like every open-source project, django CMS is always looking for motivated individuals to contribute to its source code.
In a nutshell¶
Here’s what the contribution process looks like in brief:
- Fork our GitHub repository, https://github.com/divio/django-cms
- Work locally and push your changes to your repository.
- When you feel your code is good enough for inclusion, send us a pull request.
See the How to contribute a patch how-to document for a walk-through of this process.
Basic requirements and standards¶
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 too inflexible about it.
As of django CMS 3.2, we are using the same guidelines as described in Aldryn Boilerplate
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.
If you don’t have an IRC client, you can join our IRC channel using the KiwiIRC web client, which works pretty well.
When we refer to the frontend here, we only mean the frontend of django CMS’s admin/editor interface.
In order to be able to work with the frontend tooling contributing to the django CMS you need to have the following dependencies installed:
In order to compile the stylesheets you need to run this command from the repo root:
While developing it is also possible to run a watcher that compiles Sass files on change:
By default, source maps are not included in the compiled files. In order to turn
them on while developing just add the
We are using gulp-iconfont to
generate icon web fonts into
cms/static/cms/fonts/. This also creates
cms/static/cms/sass/components which adds all
the icon classes and ultimately compiles to CSS.
In order to compile the web font you need to run:
This simply takes all SVGs within
cms/static/cms/fonts/src and embeds them
into the web font. All classes will be automatically added to
_iconography.scss as previously mentioned.
Additionally we created an SVG template within
cms/static/cms/font/src/_template.svgz that you should use when converting
or creating additional icons. It is named svgz so it doesn’t get compiled
into the font. When using Adobe Illustrator please mind the
bundled together and minified to decrease amount of requests made and improve
performance. In order to do that we use the
gulp task runner, where
command is available. We use Webpack for
webpack.config.js and their respective entry points. CMS exposes only one
global variable, named
CMS in external applications, you can only use bundles distributed by CMS, not
the source modules.