Skip to content

Latest commit

 

History

History
94 lines (64 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

94 lines (64 loc) · 2.87 KB

How to contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

  1. First, read these guidelines. Before you begin making changes, state your intent to do so in an Issue.
  2. Then, fork the project. Make changes in your copy of the repository. Then open a pull request once your changes are ready.
  3. A discussion about your change will follow, and if accepted, your contribution will be incorporated into the project codebase.

Commit messages

For commit mesaages without an issue, use the following format:

[#####] - Commit message

If the commit is related to an issue, use the following format:

(#NNN) - Commit message

Where NNN is the issue number generated by GitHub.

Release

Each release of the project is managed by the project maintainers. A release is made by creating a tag in the repository.

To create a tag, follow these steps:

  1. Update the version number in setup.py based on Semantic Versioning.
  2. Commit the change with the message [#####] - Tag A.B.C.D.

The meaning of the version number is as follows:

  • A: Major version: Incremented for incompatible API changes.
  • B: Minor version: Incremented for new features that are backwards-compatible.
  • C: Build: Incremented for pre-release versions of the software.
  • D: Patch: Incremented for bug fixes that are backwards-compatible.

Code reviews

All submissions, including submissions by project members, require review. Consult GitHub Help for more information on using pull requests.

Code style

In general, the project follows the guidelines in the Google Python Style Guide.

In addition, the project follows a convention of:

  • Maximum line length: 100 characters
  • Indentation: 4 spaces
  • PascalCase for function and method names.
  • No type hints, as described in PEP 484, to maintain compatibility with Python versions < 3.5.
  • Single quotes around strings, three double quotes around docstrings.

Testing

Use GitHub Actions to run tests on each pull request. You can run these tests yourself as well. To do this, first install the test dependencies, if any, for the project:

pip install -r ./builder/tests/requirements.txt
pip install -r ./profiles/tests/requirements.txt

And then run the tests:

python manage.py test

Linting

Please run lint on your pull requests to make accepting the requests easier. To do this, run pylint or a similar tool in the root directory of the repository. Note that even if lint is passed, additional style changes to your submission may be made during merging.