Skip to content
This repository has been archived by the owner on Nov 2, 2020. It is now read-only.

Latest commit

 

History

History
50 lines (33 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 1.72 KB
Raw

Contributing RidPT

Thank you for contributing RidPT 🎉

Templates

Please use issue/PR templates which are inserted automatically.

Found a Bug?

If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Commit Message Format

Since We use git-chglog to manage our change log, Please use this format which is influenced by Angular commit message.

<type>(<scope>): <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

Scope

The main influences part of your commit.

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 should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.