Skip to content

Latest commit

 

History

History
75 lines (53 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

75 lines (53 loc) · 2.87 KB

Contributing

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Found an Issue?

Thank you for reporting any issues you find. We do our best to test and make this project as solid as possible, but any reported issue is a real help.

Please follow these guidelines when reporting issues:

  • Create a new issue in the issue tracker.
  • Provide a title in the format of <Error> when <Task>
  • Tag your issue with the tag bug
  • Provide a short summary of what you are trying to do
  • Provide the log of the encountered error if applicable
  • Provide the exact version
  • Be awesome and consider contributing a pull request

Want to contribute?

You consider contributing changes to this project – we dig that! Please consider these guidelines when filing a pull request:

  • Follow the Coding Rules
  • Follow the Commit Rules
  • Make sure you rebased the current master branch when filing the pull request
  • Follow Clean code
  • Follow Clean architecture
  • Follow Test guidelines
  • Squash your commits when filing the pull request
  • Provide a short title with a maximum of 100 characters
  • Provide a more detailed description containing _ What you want to achieve _ What you changed _ What you added _ What you removed
  • For significant changes, post also an issue before to know if your idea has a chance to be accepted

Coding Rules

To keep the code base of commitlint neat and tidy the following rules apply to every change

  • prettier is king
  • eslint is awesome
  • Favor micro library over swiss army knives (rimraf, ncp vs. fs-extra)
  • Be awesome

You can also use npx prettier --write . to fix prettier errors

Commit Rules

To help everyone with understanding the commit history of commitlint the following commit rules are enforced:

  • conventional commits
  • present tense
  • maximum of 100 characters
  • for bugs, includes the github tag of the issue in the description.
  • message format of $type($scope): $message
  • use authorized types: build, ci, chore, docs, feat, fix, perf, refactor, revert, style, test

Using the right type is really important since it is used to increase the version number automatically.

Test

If you add a feature or fix a bug, you need to provide a unit test verifying your improvement.

Please follow AAA pattern when writing tests.

Versioning

This project use semantic versioning. The version number is increased based on the commit messages.

May the force be with you !!