Skip to content

Latest commit

 

History

History
69 lines (44 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

69 lines (44 loc) · 1.8 KB
Raw

Contributing to backport action

I welcome contributions for feature requests and bug reports, as well as for docs and code changes.

Feature requests and bug reports

If you would want to see something added or changed, or encountered a bug. Please open an issue on GitHub.

Docs changes

Saw a typo or want to make other changes to the README? Feel free to open a pull request with your changes.

Code changes

I welcome code changes. If you're thinking of opening a large pull request, please consider opening an issue on GitHub first to discuss it.

Build from source

Install the dependencies.

npm install

Apply the automatic formatting to the source code.

npm run format

Build and package the action for distribution.

npm run build && npm run package

Testing

Run all tests.

npm test

Run all tests with additional console output.

npm run test-verbose

Shorthand for format, build, package and test.

npm run all

This action can also be tested using korthout/backport-action-test.

Releases

The distribution is hosted in this repository under dist. Simply build and package the distribution and commit the changes to publish a new snapshot version.

To release a version, run the Release workflow from the branch that should be released. This sets the release version and tags the release commit. It also creates/moves the major and minor tags (e.g. v1 and v1.2) to the latest corresponding release as officially recommended.