Skip to content

Latest commit

 

History

History
40 lines (30 loc) · 1.86 KB

contributing.md

File metadata and controls

40 lines (30 loc) · 1.86 KB
Raw

Contributing to Pathfinder

Welcome, and thank you for your interest in contributing to Pathfinder!

The easiest way to do so is to open issues for questions, bug reports and areas where documentation is lacking.

At this stage the code and documentation is still in a pretty rough shape, so finding a place to contribute actual code can be difficult. If you do feel like tackling an open issue, please do comment on the issue or open a PR. We are happy to guide you through the process.

py/ directory

The main purpose of the py/ is to interface with cairo-lang which currently has a custom license. It is possible we will have to change the license of py/ in future to accommodate these changes. When contributing to python parts under py/ please agree to future relicensing to stay compatible with any future cairo-lang license by including this text in your PR:

As the author of this PR I explicitly agree to any relicensing of my contributions under py/ directory as per repository's contributing.md.

Pull-requests

Keeping these points in mind will increase the odds of a successful PR:

  • Keep the PR small.
  • Have an accurate description of your changes and intentions with the PR.
  • Code comments should describe the why and not the how.
  • New features should have reasonable tests.
  • Ensure CI is happy. CI will run automatically when the PR is opened. This includes checks checks for
    • formatting (cargo fmt)
    • linting (cargo clippy)
    • testing (cargo test)
  • We (loosely) follow the conventional commits specification.
  • Commit messages should be sensible and descriptive.
  • No extra merge commits in the PR. This usually only occurs if you've merged another branch into your PR branch. You should use git rebase instead.