Thank you for contributing to GitHub Workflow Accelerators. This document is the starting point for contributors — human or AI.
- bats-core — for running shell script tests locally
- markdownlint-cli2 — for linting markdown
- shellcheck — recommended for shell script authoring
See LINTING.md and TESTING.md for setup details.
| Task | Document |
|---|---|
| Add a new action | ADDING_AN_ACTION.md |
| Modify an existing action | UPDATING_AN_ACTION.md |
| Write tests for shell scripts | WRITING_TESTS.md |
| Understand CI/CD workflows | DEVOPS.md |
mainis a protected branch — all changes must go through a pull request- Branch naming:
feat/,fix/,chore/prefixes (e.g.feat/add-notify-slack) - Each PR should change only the action(s) it intends to change
- PRs that change an action's files must include a
project.jsonversion bump — see UPDATING_AN_ACTION.md
Use conventional commit prefixes:
feat:— new action or new feature in an existing actionfix:— bug fixchore:— dependency updates, version bumps, tooling changesdocs:— documentation only changesrefactor:— code changes that don't affect behaviourtest:— adding or updating tests
- The
code-quality.ymlPR gate must pass before merging - Markdownlint and bats tests run automatically for changed files — see DEVOPS.md