You are very welcome improving this boilerplate for Aldryn and your everyday use, especially the documentation always needs love. Feel free to fork and send us pull requests and follow the guidelines from within this section.
Code of Conduct
- Ensure code validates against or own guidelines
- Write documentation about what you are doing
- If you are not sure, just ask - join our community #aldryn on Freenode
In addition, follow the steps underneath to get them running:
- clone the repository using
git clone https://github.com/aldryn/aldryn-boilerplate-bootstrap3.git
- navigate to the documentation through
make installto install additional requirements
make runto let the server run
Now you can open http://localhost:8000 on your favourite browser and start
changing the rst files within
You need to be aware of reStructuredText to format the documentation properly.
- Always start paths with a
/and leave the trailing slash.
- Leave two spaces before a title.
- Write "Django", "django CMS" or "Aldryn".
- Additional guidelines from django CMS apply.
Before starting to work on issues or features, please mind the branching model:
- master is used for hotfix releases (1.1.x)
- develop is used for features and issues (1.x.x)
Everything that is merged to develop will be released within the next proper release (1.x.x). Major releases (x.0.0) will have their own branches but are always merged to develop before releasing to master.
A pull request needs the consent of two developers familiar with this repository to be merged.
- Adapt the CHANGELOG.rst
- Adapt AUTHORS.rst if required
- Bump version in boilerplate.json
- Create a GitHub tag
- Add the release notes on the GitHub tag
- Build new tag on readthedocs.org
bash tools/release.shbefore release on Aldryn
aldryn boilerplate uploadto release on Aldryn
- Test, inform, present