Skip to content

Latest commit

 

History

History
165 lines (113 loc) · 5.37 KB

CONTRIBUTING.rst

File metadata and controls

165 lines (113 loc) · 5.37 KB
Raw

Contributing

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

Report bugs at https://github.com/nephila/djangocms-page-sitemap/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.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "feature" is open to whoever wants to implement it.

Write Documentation

djangocms-page-sitemap could always use more documentation, whether as part of the official djangocms-page-sitemap docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/nephila/djangocms-page-sitemap/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 :)

Get Started!

Ready to contribute? Here's how to set up djangocms-page-sitemap for local development.

  1. Fork the djangocms-page-sitemap repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/djangocms-page-sitemap.git

  3. 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-page-sitemap
$ cd djangocms-page-sitemap/
$ pip install -r requirements-test.txt
$ pip install -e .

  4. 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:

$ tox

To get flake8 and tox, just pip install them into your virtualenv.

  1. 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

  2. Submit a pull request through the GitHub website.

Development tips

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 pre-commit install.

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.

Testing tips

You can test your project using any specific combination of python, django and django cms.

For example tox -epy3.7-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:

  1. Pull request must be named with the following naming scheme:

    <type>/(<optional-task-type>-)<number>-description

    See below for available types.

  2. The pull request should include tests.

  3. If the pull request adds functionality, the docs should be updated. Documentation must be added in docs directory, 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.

  4. Add a changes file in changes directory 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.

  5. 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

  1. Update authors file
  2. Merge develop on master branch
  3. Bump release via task: inv tag-release (major|minor|patch)
  4. Update changelog via towncrier: towncrier --yes
  5. Commit changelog with git commit --amend to merge with bumpversion commit
  6. Create tag git tag <version>
  7. Push tag to github
  8. Publish the release from the tags page
  9. If pipeline succeeds, push master
  10. Merge master back on develop
  11. Bump developement version via task: inv tag-dev -l (major|minor|patch)
  12. Push develop