Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

38 lines (25 loc) · 1.4 KB

Contributing

Raising issues

Before raising an issue, make sure you have checked the open and closed issues to see if an answer is provided there. There may also be an answer to your question on stackoverflow.

Please provide the following information with your issue to enable us to respond as quickly as possible.

  • The relevant versions of the packages you are using.
  • The steps to recreate your issue.
  • An executable code example where possible. You can fork this repository and use one of the examples to quickly recreate your issue.

Commit messages

Pact JS uses the Conventional Changelog commit message conventions. Please ensure you follow the guidelines.

Take a look at the git history (git log) to get the gist of it.

If you'd like to get some CLI assistance, getting setup is easy:

npm install commitizen -g
npm i -g cz-conventional-changelog

git cz to commit and commitizen will guide you.

Pull requests

  • Write tests for any changes
  • Follow existing code style and conventions
  • Separate unrelated changes into multiple pull requests
  • For bigger changes, make sure you start a discussion first by creating an issue and explaining the intended change