Thanks for taking the time to contribute to this open source project 👍.
- Make sure you have a GitHub account.
- Fork this repository on GitHub.
- Create a feature branch from where you want to base your work.
- This will almost always be the
master
branch. - Avoid working directly on the
master
branch.
- This will almost always be the
- Make commits of logical and atomic units, with unit tests written where applicable using the Pytest framework.
- Check for unnecessary whitespace with
git diff --check
before committing. - When committing, always write a clear commit message. Larger changes should follow the below structure.
$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."
- Push your changes to a feature branch in your fork of the repository.
- Open a GitHub pull request with a clear list of changes made (read more about pull requests).