Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report bugs at https://github.com/nephila/djangocms-redirect/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
djangocms-redirect could always use more documentation, whether as part of the official djangocms-redirect docs, in docstrings, or even on the web in blog posts, articles, and such.
The best way to send feedback is to file an issue at https://github.com/nephila/djangocms-redirect/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Ready to contribute? Here’s how to set up
djangocms-redirect for local development.
djangocms-redirectrepo on GitHub.
Clone your fork locally:
$ git clone email@example.com:your_name_here/djangocms-redirect.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv djangocms-redirect $ cd djangocms-redirect/ $ pip install -r requirements-test.txt $ pip install -e .
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
To get tox, pip install it into your virtualenv.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
This project allows you to use pre-commit to ensure an easy compliance to the project code styles.
If you want to use it, install it globally (for example with
pip3 install --user precommit,
but check installation instruction.
When first cloning the project ensure you install the git hooks by running
From now on every commit will be checked against our code style.
Check also the available tox environments with
tox -l: the ones not marked with a python version number are tools
to help you work on the project buy checking / formatting code style, running docs etc.
You can test your project using any specific combination of python, django and django cms.
tox -py37-django30-cms37 runs the tests on python 3.7, Django 3.0 and django CMS 3.7.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
Pull request must be named with the following naming scheme:
See below for available types.
The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Documentation must be added in
docsdirectory, and must include usage information for the end user. In case of public API method, add extended docstrings with full parameters description and usage example.
Add a changes file in
changesdirectory describing the contribution in one line. It will be added automatically to the history file upon release. File must be named as
<issue-number>.<type>with type being:
.feature: For new features.
.bugfix: For bug fixes.
.doc: For documentation improvement.
.removal: For deprecation or removal of public API.
.misc: For general issues.
Check towncrier documentation for more details.
The pull request should work for all python / django / django CMS versions declared in tox.ini. Check the CI and make sure that the tests pass for all supported versions.
Release a version¶
- Update authors file
- Bump release via task:
inv tag-release (major|minor|patch)
- Update changelog via towncrier:
- Commit changelog with
git commit --amendto merge with bumpversion commit
- Create tag
git tag <version>
- Push tag to github
- Publish the release from the tags page
- If pipeline succeeds, push
- Bump developement version via task:
inv tag-dev -l (major|minor|patch)