Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 1.61 KB
Raw

How to contribute

Setup the repository locally

First, fork remote repository via pushing Fork button.

Setup the repository locally. Replace <your account name> with the name of the account you forked to.

git clone https://github.com/<your account name>/tsconfig.git
cd tsconfig

Submitting the Pull Request

  • Create a new branch locally.
  • Make your changes in that branch and push them to your fork
  • Submit a pull request from your topic branch to the main branch on the wonize/tsconfig repository.
  • Be sure to tag any issues your pull request is taking care of / contributing to. Adding "Closes #123" to a pull request description will automatically close the issue once the pull request is merged in.

Release 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, use the Squash & merge button.