diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 112de699bd8..74c70b0a74c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -25,6 +25,7 @@ Fixes #0000 diff --git a/AGENTS.md b/AGENTS.md index 3103b5ae408..541612db797 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -33,6 +33,15 @@ Adhere to the following guidelines in your code: - In tests, always avoid mocking the filesystem. Use real files and directories, in temporary directories if needed. - In tests, prefer to have as little shared state between tests as possible. Avoid beforeAll and afterAll. +### PR creation + +- Use GitHub stacks for multiple dependant PRs +- Follow the template from .github/PULL_REQUEST_TEMPLATE.md +- Be concise +- Remove empty sections and hidden comments +- Do not mark checklist items as completed (except the changelog one if added) +- In "How to test your changes?" only include CLI commands to test locally, do not add commands to run tests or other checks + ## Changesets Add a changeset only when the change is user-facing and ready to appear in public changelogs and release notes.