Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (42 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

62 lines (42 loc) · 2.01 KB

Contributing

General rules

  1. Before writing any code take a look at the existing issues. If none of them is about the changes you want to contribute, open up a new issue. Fixing a typo requires no issue though, just submit a Pull Request.

  2. If you're looking for an open issue to fix, check out labels help wanted and good first issue on GitHub.

  3. Another valuable contribution is adding new translations by adding a new directory in the translations, copying an example .po file and providing new translations.

  4. If you plan to work on an issue open not by you, write about your intention in the comments before you start working.

Development rules

  1. Follow the GitHub fork & pull request flow.

  2. Make changes to the code.

  3. Make sure the pylinter is happy

  4. Open a pull request, refer to the issue you solve.

  5. Make sure GitHub Checks (Actions) pass.

Release management

  1. Follow the SemVer conventions for the release number.
  2. Update the version in file_version_info as well as the main.py.
  3. Update the CHANGELOG.
  4. Update the README if needed.
  5. Merge the changes to the main branch.
  6. Push a version-specific tag, e.g. v2.1.9:
$ git tag v2.1.9
$ git push origin v2.1.9
  1. Push a new or over a major version tag, e.g. v2.
# Delete the old local tag
$ git tag -d s

# Add a new local tag
$ git tag v2

# Delete the old remote tag
$ git push -d origin v2

# Push the new remote tag
$ git push origin v2