Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 993 Bytes

CONTRIBUTING.md

File metadata and controls

25 lines (19 loc) · 993 Bytes

This project uses Rust, so use the usual cargo commands in order to build and run the desired binaries/tests.

Issue reporting

I'm using Github in order to host the code. Thus, in order to report issues you can do it on its issue tracker. A couple of notes on reports:

  • Check that the issue has not already been reported or fixed in the main branch.
  • Try to be concise and precise in your description of the problem.
  • Provide a step by step guide on how to reproduce this problem.
  • Provide the version you are using (git commit SHA).

Pull requests

  • Write a good commit message.
  • Run the tests (cargo test).
  • Update the changelog.
  • Open a pull request with only one subject and a clear title and description. Refrain from submitting pull requests with tons of different unrelated commits.