Skip to content

Latest commit

 

History

History
69 lines (42 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

69 lines (42 loc) · 1.64 KB
Raw

Contributing Guidelines


Contributors

1. Commits

Use git-commit-template for commit messages guidelines. More information Read about Conventional Commits.

Always

  • Provide proper comments

Maybe

  • Try not to keep more than 72 chars per line

Never

  • Commit any sensitive information
  • Commit trailing whitespaces
  • Keep an empty line at the end of any file

2. Creating Pull Requests

  • Rebase your fix branch on top of the target branch before creating a PR
  • Update README.md to reflect breaking changes

Maintainers

1. Merging Pull Requests

  • Do not use GitHub's Merge Changes button to merge PRs. It creates unnecessary merge commits
  • Fetch the fix branch locally using GitHub's pull refspec
  • Rebase the fix branch on the target branch
  • Merge fix branch in target branch

Source: https://git-scm.com/book/en/v2/GitHub-Maintaining-a-Project#_pr_refs

2. Releases

Strictly follow Semantic Versioning.

Use semantic-release:

Action Snippet
Install npm install -g semantic-release@15
Access Token export GITHUB_TOKEN=XXXXXXXXXXXXXX
Dry run semantic-release -d
Release semantic-release

Code of Conduct

The Code of Conduct is adapted from the Contributor Covenant, version 1.4.