Skip to content

Latest commit

 

History

History
75 lines (49 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

75 lines (49 loc) · 2.45 KB
Raw

Contributing guidelines

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to Python version of spid-compliant-certificates project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How to contribute

  1. If you found something to add/fix, open an issue an discuss with the community

  2. Once ready, fork the repository (or pull from main if already forked)

  3. In your fork, create a branch starting from main and name it by following the naming conventions

  4. Make your changes by following the coding guidelines

  5. Push the changes on your branch and create a pull request

  6. Wait for a review

Coding guidelines

  1. Use four spaces for intentation (leave TABS to Java lovers)

  2. Use type hints (see PEP484) when a new function is defined

  3. Use \n as end of line (we mainly develop on Linux)

  4. Before pushing your Python code, lint it with flake8 and isort (see PEP8)

  5. Before pushing your changes on Dockerfiles, lint them with hadolint

Branches naming conventions

Releases are issued by making use of Release Drafter action. In order to propery work, some naming conventions for branches must be followed.

Bugfix

If you're working on a bugfix, please name your local branch with one of the following prefixes:

  • bug (e.g. bug/wrong-url-in-configuration)
  • bugfix (e.g. bugfix/wrong-url-in-configuration)
  • fix (e.g. fix/wrong-url-in-configuration)

New feature

If you're working on a new feature, please name your local branch with one of the following prefixes:

  • enhancement (e.g. enhancement/enable-2fa-with-solokey)
  • feat (e.g. feat/enable-2fa-with-solokey)
  • feature (e.g. feature/enable-2fa-with-solokey)

Maintenance

If you're working on maintenance tasks (e.g. documentation, repository management, source styling), please name your local branch with one of the following prefixes:

  • chore (e.g. chore/remove-trailing-spaces)
  • style (e.g. style/remove-trailing-spaces)