Skip to content

Latest commit

 

History

History
17 lines (12 loc) · 816 Bytes

File metadata and controls

17 lines (12 loc) · 816 Bytes

Contributing

Help with this project is certaily welcome.

When making commits, please try to use git commit comments that follow the conventions in the following section.

Git conventions

comment prefixes

  • FEAT: when the commit adds/removes/changes some functionality of the library
  • FIX: fixing a bug
  • TODO: adding a todo
  • REFACTOR: things like name changes, that do not change the functionality as such
  • DOCS: adding/removing comments, or actual documentation
  • CHORE: things like updating library version number, updating gitignore file.
  • TIDY: things like adding/removing whitespaces, or non-executable text like separators/decorators to make the code more readable. Also when repositioning the order of chunks of code (where the position makes no difference to the functionality)