Skip to content
This repository was archived by the owner on Jan 12, 2021. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (35 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

51 lines (35 loc) · 1.73 KB

Contribution Guidelines

We are happy you're here and wanting to contribute to bugsnag-sourcemaps!

To get started, first fork the library on GitHub. Then:

  • Build and test your changes
  • Commit and push until you are happy with your contribution
  • Make a pull request describing what you've changed or added and why. The more you can tell about your use case helps us to know how to approach review and further discussion.
  • Have a nice day! We'll get back to you soon. ✨

Thank you!

Installing the development dependencies

All of the resources required to build and develop bugsnag-sourcemaps are available via npm. To install, run npm install.

Running the tests

The tests depend on the npm dependencies. Once installed, run npm test.

Releasing a new version

If you are a project maintainer, you can release a new version of the library like so:

  1. Write new/updated documentation for uploading source maps to Bugsnag for browser JS or React Native as needed. Submit for review. Start launch music.

  2. Commit any outstanding changes.

  3. Add an entry to CHANGELOG.md describing the new features and fixes in the upcoming release. Choose a release version number according to semantic versioning.

  4. Update the version number in package.json to match the change log.

  5. Commit, tag the commit, and push:

    $ git commit -am "Release v1.x.x" \
    && git tag v1.x.x \
    && git push origin master v1.x.x

  6. Publish a new release on npm by running npm publish.

  7. Release the new documentation, if any.