Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

66 lines (42 loc) · 1.78 KB

Contributing

Hi 👋 thanks for stopping by.

We release contributions to this under the project's open source license.

Tracking work

We're currently tracking issues/ideas in issues.

Submitting a pull request

  1. Fork and clone the repository.
  2. Follow the local development setup.
  3. Make sure the tests pass on your machine: npm test.
  4. Create a new branch: git checkout -b my-branch-name.
  5. Make your change, add tests, and make sure the tests still pass.
  6. Push to your fork and submit a pull request.
  7. Wait for your pull request to be reviewed and merged.

Local setup

You should run Nodejs 16 to match the action's version.

Using nodeenv is recommended.

nodenv install
npm install

Development

Write code, tests and verify that everything is correctly running with:

npm run test
npm run lint
npm run fix

See package.json for details.

Build

GitHub Actions runs the entry point from the action.yml. Packaging assembles the code into a single file. We will add the file in to Git for fast and reliable execution. It also prevents the need to check in node_modules.

Actions are run from GitHub repositories. Packaging the action will create a packaged action in the dist folder.

npm run build

ℹ️ NODE_OPTIONS=--no-experimental-fetch is needed to minify. See parcel-bundler/parcel#8005 (comment)

Release

ℹ️ Only contributors with write-access will be able to do this step.

Use the release.sh to create a new tag and open a new draft release.

See the file for configuration.

./scripts/release.sh