Skip to content
This repository has been archived by the owner on May 25, 2021. It is now read-only.

Latest commit

 

History

History
71 lines (48 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

71 lines (48 loc) · 2.73 KB

Contributing

💖 First things first, thank you for contributing. 💖 We know it takes a lot of time and effort.

Code of Conduct

In the interest of making the Augury project a safe and friendly place for people from diverse backgrounds, we'll be adhering to a Contributor Code of Conduct. As a contributor, you'll be expected to uphold this code as well as report unacceptable behaviour to [email protected].

Got a Question or Problem?

If you have a general question reach out to us using one of the following methods:

Found a Bug?

  • Please check if the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible.

Missing a Feature?

You can request a new feature by submitting a feature request. If you would like to implement a new feature, please submit an issue with a proposal for your work first.

Submitting a Pull Request (PR)

Pull requests are welcome. Make sure you read the development guide guide for details on how to setup the development environment. Before submitting a pull request please discuss the change via issue first and then open a pull request.

See Conventional Commits for commit guidelines.

Cutting a Release

Publishing to npm is handled with lerna, which will update version numbers, create tagged releases in GitHub and also publish the packages to npm.

In order to publish to npm you'll need to be part of the @augury organization.

Here are some examples for releasing different versions updates:

# release a patch (e.g. from 0.5.2 -> 0.5.3)
yarn release patch

# release a minor update (e.g. from 0.5.3 -> 0.6.0)
yarn release minor

# release a minor beta update (e.g. from 0.5.0 -> 0.6.0-beta.0)
yarn release preminor --preid beta --dist-tag beta

# patch a beta a minor beta patch (e.g. from 0.6.0-beta.0 -> 0.6.0-beta.1)
yarn release patch --preid beta --dist-tag beta

# release a major update (e.g. from 1.6.2 -> 2.0.0)
yarn release major

See lerna publish for more details.