Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

28 lines (23 loc) · 1.2 KB

Contributing

We welcome pull requests from everyone.

Commits

Please pay attention to detailed and meaningful commit messages.

A good summary, thx to: https://www.freecodecamp.org/news/writing-good-commit-messages-a-practical-guide/

  • Specify the type of commit:
    • feat: The new feature you're adding to a particular application
    • fix: A bug fix
    • style: Feature and updates related to styling
    • refactor: Refactoring a specific section of the codebase
    • test: Everything related to testing
    • docs: Everything related to documentation
    • chore: Regular code maintenance.
  • Separate the subject from the body with a blank line
  • Your commit message should not contain any whitespace errors
  • Remove unnecessary punctuation marks
  • Do not end the subject line with a period
  • Capitalize the subject line and each paragraph
  • Use the imperative mood in the subject line
  • Use the body to explain what changes you have made and why you made them.
  • Do not assume the reviewer understands what the original problem was, ensure you add it.
  • Do not think your code is self-explanatory
  • Follow existing commit conventions, for example: https://www.conventionalcommits.org