Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 1.06 KB
Raw

Contributing to flatdir

How to Contribute

Would you like to contribute to flatdir? Awesome! 💖

  1. Create an issue describing the intended change.
  2. Your draft is reviewed by a team member. Make the requested changes, if any.
  3. Create a topic branch.
  4. Code…
  5. Run the code checks and fix any reported issues.
  6. Create a pull request.
  7. Your contribution is reviewed by a team member. Make the requested changes, if any.
  8. Your contribution is merged by a team member. 🥳

A good issue description contains:

  • If the API is modified, any class or function signature
  • If the UI is modified, a simple sketch
  • If a dependency is introduced, the rationale why it is a better choice than alternatives

Installing Development Dependencies

To install all development dependencies, run:

make deps-dev

Running Code Checks

To run all unit tests, use:

make

All available code checks (type, test and style) can be run with:

make check