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.
Hey, that's awesome you want to help! If you're not sure where to start, look for the help wanted
label in our issue tracker. If you have an idea that you think would be great, come and chat to us on slack in the #pact-js channel.
Pact JS uses the Conventional Changelog commit message conventions. Please ensure you follow the guidelines, we don't want to be that person, but the commit messages are very important to the automation of our release process.
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-changeloggit cz to commit and commitizen will guide you.
We use Prettier for formatting, and for linting we use TSLint (for TypeScript).
Please update your editor to enable Prettier, and things should be easy 👌. If not, our lint step will catch it.
- 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