CONTRIBUTING.md

Contributing

Please read the following document.

• https://github.com/suzuki-shunsuke/oss-contribution-guide

Requirements

• aqua: CLI Version Manager
  • cmdx: Task Runner
• Node.js
  • prettier: Formatter

Install cmdx by aqua.

aqua i -l

After you update code, you have to run the following things.

• Build TypeScript
• Test JavaScript Action
• Format code
• Update JSON Schema and document

Node.js version management

This project depends on Node.js, and there are a lot of Node.js version managers. This project supports a lot of Node.js version managers.

• aqua: aqua/node.yaml
• NVM: .nvmrc
• .node-version: https://github.com/shadowspawn/node-version-usage
  • asdf, mise, fnm, nodeenv, etc
• volta: package.json

These versions must be same.

Node.js package manager

We manage Node.js packages using npm, not yarn and pnpm.

dist directories aren't committed

#1913

We don't manage transpiled JavaScript files in the main branch and feature branches anymore.

Test JavaScript Actions

npm t

Format code

cmdx fmt

Manual test

We provide some automatic tests such as unit tests, but sometimes the automatic tests aren't enough so you have to test your changes on your environment. You have to build GitHub Actions workflows with tfaction and test your changes on the workflows.

When a pull request is created or updated, the branch pr/<pull request number> is also created or updated by GitHub Actions.

• https://github.com/suzuki-shunsuke/tfaction/actions/workflows/create-pr-branch.yaml
• https://github.com/suzuki-shunsuke/tfaction/blob/main/.github/workflows/create-pr-branch.yaml

Warning

These branches aren't created and updated against pull requests from fork repositories. Maintainers have to run the workflow manually.

You can test your pull request version by pr/<pull request number>.

For example, if you want to test the pull request #1513, you can update tfaction's version of your workflows to pr/1513.

e.g.

- uses: suzuki-shunsuke/tfaction/setup@pr/1513