Skip to content

Latest commit

 

History

History
49 lines (29 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

49 lines (29 loc) · 1.2 KB

Contributing to bugsnag-erlang

Testing

Submit unit tests for your changes. You can test your changes on your machine by running the test suite:

make test

When you submit a PR, tests will also be run on the continuous integration environment via GitHub Actions.

You should run this command before releasing.

Formatting

If your editor doesn't automatically format Erlang code using erlfmt, run:

make format

Releasing

The following instructions uses $VERSION as a placeholder, where $VERSION is a MAJOR.MINOR.BUGFIX release such as 1.2.0.

  1. Run the test suite and ensure all the tests pass.

  2. Finalize the ## main section in CHANGELOG.md assigning the version.

  3. Commit and push the changes

    git commit -a -m "Release $VERSION"
git push origin main

  4. Wait for CI to complete.

  5. Create a signed tag.

    git tag -a v$VERSION -s -m "Release $VERSION"
git push origin --tags

  6. GitHub actions will take it from there and release to https://hex.pm/packages/bugsnag_erlang