Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

39 lines (26 loc) · 1.69 KB

Contributing

In order to contribute to this project, please follow these style guide and workflow.

Coding Style Guide

Please follow this for the sake of the code to be as readable and maintainable as possible.

  • Use your best spelling and punctuation, in English.
  • Please use black and isort packages to format your code.
  • Please use pylint and/or pylance packages to lint your code for any possible errors.
  • Please use mypy package to ensure that the data types that you code are correct.

All of the packages are available in the pyproject.toml file.

Example Usage

Below is an example usage of how to conform to the coding style.

cd Satella
black .
isort .
mypy .
pylint src

Commit Style Guide

Please use Semantic Commit Messages, but with past tense and first letter capitalized. For further details, please check this gist and this website. Using these kinds of commit messages will make contributors into better programmers because of its rigid style. Another reason of using it is because its rigid style actually forces contributors to not commit lots of files in one setting.

Workflow

In order to contribute to this project, please create an issue about the problem that you are going to fix / add so that we can discuss it together. After that, follow these instructions below.

  • Fork the repository.
  • Create a new branch based on the issue number that you created beforehand. Example: git checkout -b 10.
  • Commit and push your features / changes.
  • Create a new pull request.