Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

56 lines (36 loc) · 2.5 KB
Raw

Contributing

Thank you for considering to contribute to github-app-webhook-relay-polling 💖

Please note that this project is released with a Contributor Code of Conduct. By participating you agree to abide by its terms.

Setup

Node.js 16 or higher is required. Install it from https://nodejs.org/en/. GitHub's gh CLI is recommended for the initial setup

  1. Fork this repository and clone it to your local machine. Using gh you can do this

    gh repo fork gr2m/github-app-webhook-relay-polling

  2. After cloning and changing into the github-app-webhook-relay-polling directory, install dependencies and run the tests

    npm install
npm test

Few notes

  • npm test runs all kind of tests. You can run the code tests in isolation with npm run test:code. Use npm run to see all available scripts.
  • If coverage drops, run npm run coverage to open a coverage report in your browser.
  • Make sure that update types in index.d.ts that reflect any features / fixes you might have implemented.

Issues before pull requests

Unless the change is trivial such as a type, please open an issue first before starting a pull request for a bug fix or a new feature.

After you cloned your fork, create a new branch and implement the changes in them. To start a pull request, you can use the gh CLI

gh pr create

Maintainers only

Merging the Pull Request & releasing a new version

Releases are automated using semantic-release. The following commit message conventions determine which version is released:

  1. fix: ... or fix(scope name): ... prefix in subject: bumps fix version, e.g. 1.2.3 → 1.2.4
  2. feat: ... or feat(scope name): ... prefix in subject: bumps feature version, e.g. 1.2.3 → 1.3.0
  3. BREAKING CHANGE: in body: bumps breaking version, e.g. 1.2.3 → 2.0.0

Only one version number is bumped at a time, the highest version change trumps the others. Besides, publishing a new version to npm, semantic-release also creates a git tag and release on GitHub, generates changelogs from the commit messages and puts them into the release notes.

If the pull request looks good but does not follow the commit conventions, update the pull request title and use the Squash & merge button, at which point you can set a custom commit message.