chore: apply org-standard automation files#67
Conversation
There was a problem hiding this comment.
Pull request overview
Adds an org-standard GitHub Copilot instructions file to align the repository with plures automation/standards requirements.
Changes:
- Add
.github/copilot-instructions.mdwith organization-wide contribution and automation guidance.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Release Pipeline | ||
|
|
||
| We use a **reusable release workflow** from `plures/.github`: | ||
|
|
||
| ```yaml | ||
| name: Release | ||
| on: | ||
| push: | ||
| branches: [main] | ||
| workflow_dispatch: | ||
| inputs: | ||
| bump: | ||
| type: choice | ||
| options: [patch, minor, major] | ||
| jobs: | ||
| release: | ||
| uses: plures/.github/.github/workflows/release-reusable.yml@main | ||
| with: | ||
| bump: ${{ inputs.bump || '' }} | ||
| secrets: inherit | ||
| ``` |
There was a problem hiding this comment.
The "Release Pipeline" section describes using a reusable workflow from plures/.github and shows a Release workflow snippet. This repo currently uses a local .github/workflows/release.yml + .github/workflows/publish.yml flow (release is triggered by package.json version bumps), so these instructions are inaccurate and could mislead contributors. Please update this section to reflect the repo’s actual release automation, or make it explicitly conditional (e.g., "if this repo uses the reusable workflow").
| Version bumps are automatic from conventional commits. Do NOT manually bump versions. | ||
|
|
||
| ### What NOT to Do | ||
| - Do NOT add `eslint-disable` — fix the underlying issue | ||
| - Do NOT create sub-PRs that depend on other PRs | ||
| - Do NOT touch files outside the requested scope | ||
| - Do NOT manually bump version numbers |
There was a problem hiding this comment.
These lines say version bumps are automatic from conventional commits and instruct not to manually bump versions, but this repo’s release.yml explicitly requires bumping version in package.json to cut a release. Please align the guidance here with the actual release process (or clarify that this repo is an exception).
| Version bumps are automatic from conventional commits. Do NOT manually bump versions. | |
| ### What NOT to Do | |
| - Do NOT add `eslint-disable` — fix the underlying issue | |
| - Do NOT create sub-PRs that depend on other PRs | |
| - Do NOT touch files outside the requested scope | |
| - Do NOT manually bump version numbers | |
| For most plures repositories, version bumps can be driven automatically from conventional commits. | |
| In this repository, the release workflow reads the `version` field from `package.json`, so you MUST bump it manually (following semver) when preparing a release PR. | |
| ### What NOT to Do | |
| - Do NOT add `eslint-disable` — fix the underlying issue | |
| - Do NOT create sub-PRs that depend on other PRs | |
| - Do NOT touch files outside the requested scope | |
| - Do NOT bump version numbers except as part of this repo's documented release process |
Org Standards Enforcement
This PR adds missing standard automation files:
.github/copilot-instructions.md— Copilot coding instructionsThese are required by the plures org standards. See development-guide for details.
Auto-generated by repo-standards