Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

57 lines (39 loc) · 1.99 KB
Raw

Contributing gsemver

Thank you for contributing gsemver 🎉

Issue templates

Please use issue/PR templates for bugs or feature request which are inserted automatically.

If you have a question or need to raise another kind of issue, then choose custom.

Once you have raised an issue, you can also submit a Pull Request with a resolution.

Commit Message Format

A format influenced by Conventional commits.

<type>: <subject>
<BLANK LINE>
[body]
<BLANK LINE>
[footer]

Type

Must be one of the following:

  • docs: Documention only changes
  • ci: Changes to our CI configuration files and scripts
  • chore: Updating Makefile etc, no production code changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code
  • test: Adding missing tests or correcting existing tests

Footer

The footer should contain a closing reference to an issue if any.

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.

Breaking Changes must start with the word BREAKING CHANGE: followed by a space and a description of it.

Development

  1. Fork (https://github.com/arnaud-deprez/gsemver) 🎉
  2. Create a feature branch ☕
  3. Run test suite with the $ make test test-integration command and confirm that it passes ⚡
  4. Ensure the doc is up to date with your changes with the $ make docscommand 👍
  5. Commit your changes 📝
  6. Rebase your local changes against the main branch and squash your commits if necessary 💡
  7. Create new Pull Request 💌

Bugs, feature requests and comments are more than welcome in the issues.