diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 112de699bd8..c40d377415b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -21,10 +21,11 @@ Fixes #0000 Before / after screenshots appreciated for UI changes. --> -### How to test your changes? +### How to manually test your changes? diff --git a/AGENTS.md b/AGENTS.md index 3103b5ae408..809b20882d9 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. +- Write a concise description, explaining the problem and the high-level approach. Include implementation details only when they help reviewers understand a decision or tradeoff. Avoid repeating what is clear from the diff. Example for the WHAT section: "Refresh expired credentials before retrying the requests, so users can continue without signing in again". +- 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.