Skip to content
This repository has been archived by the owner on Oct 7, 2023. It is now read-only.

Latest commit

 

History

History
31 lines (18 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

31 lines (18 loc) · 1.32 KB
Raw

Contributing

First, a big thank you has to go to you for showing interest in contributing to the Lifter API wrapper.

Please report any bugs through GitHub issues.

Code of Conduct

  • Please be friendly
  • More to be written...

Contributing Code

Here’s what the pull request process looks like in brief:

  • Fork the GitHub repository, https://github.com/WeightliftingNZ/lifter-api-wrapper
  • Work locally and push your changes to your repository.
  • When you feel your code is good enough for inclusion, send us a pull request.
  • If all is well, have the code merged into the project (any be thanked for you contribution)

Lifter API Wrapper follows the Conventional Commits Guidelines, please have a look.

Additionally, it is recommended to use pre-commit for local development. This will ensure consistent code quality before each commit.

For testing, it will be a good idea to also clone the Lifter API as this is required to run tests.

Styles

Docstrings are in Google format.

The function and variables names are to use snake case (e.g. snake_case).