Contribution Guidelines

July 24, 2020 · View on GitHub

Thanks 🙏💐 for taking the time to contribute!

The following set of guidelines are the standard to contribute to this project. Feel free to propose an improvement to this document through a pull request.

Code of Conduct

All the participations in this project are governed by Contributor Covenant Code of Conduct. Please have a look at it to familiarize yourself, if not already.

Pull Requests

Please raise the pull requests against dev branch.

Git Commits

Please adhere to Conventional Commits specification while composing a commit message. In addition,

  • Use the present tense, e.g., add status badges, not added status badges
  • Use lowercase, except when to emphasize or when a name can't be used in lowercase.
  • Use the imperative mood, e.g., add light and dark themes, not adds light and dark themes
  • Prefix the commits with a type, which consists of a noun, feat, fix, chore, etc.
  • Provide a scope to describe a section of codebase surrounded by parenthesis, e.g., fix(ci)
  • Use the type feat when a commit adds a new feature.
  • Use the type fix when a commit represents a bug fix.
  • Use the type chore when a commit represents anything else and provide the scope to clarify the context of commit, e.g., chore(deps)
  • Provide a description after adding a colon and a space after the type/scope prefix, e.g., chore(deps): bump some dependencies
  • Optionally, provide a long description in the commit body, which begins one blank line after the description.
  • Indicate a breaking change by adding a ! immediately before the :, e.g., chore!: prepare v0.7.0