Skip to content
This repository has been archived by the owner on Sep 20, 2022. It is now read-only.

Latest commit

 

History

History
23 lines (21 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

23 lines (21 loc) · 1.15 KB
Raw

Contributing

Principle & Contribution standard:

  • Use only standard lib methods shipped with the language
  • Write readable, correct and simple code (Keep It Simple and Stupid)
  • Comment incomprehensible code
  • Comply with the Conventional Commit Messages Standard (in commits and pr's)
  • Avoid merge commits (use rebase merging)

Contribution Guide:

  1. Create an issue for the bug you want to fix or the feature that you want to add.
  2. Create your own fork on GitHub, then checkout your fork.
  3. Write your code in your local copy. It's good practice to create a branch for each new issue you work on, although not compulsory.
  4. To run the test suite:
    • make build to check if cpak still compiles
    • make test/unit for unit tests
    • make test/cli for testing cli commands.
  5. If the tests pass, you can commit your changes to your fork and then create a pull request from there. Make sure to reference your issue from the pull request comments by including the issue number e.g. #123.