diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2497e28dc9..348566cd88 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -8,9 +8,9 @@ - [] The relevant docs, if any, have been updated or created - [] The relevant tests, if any, have been updated or created -## Screenshots +## Screen recording or screenshot -[ For visual changes, include screenshots. Screen recordings are particularly helpful, and appreciated! ] +[ When applicable, please include a short screen recording or screenshot - this makes it much easier for us as contributors to review and understand your changes. See [this PR](https://github.com/continuedev/continue/pull/6455) as a good example. ] ## Tests diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6d89e46551..9824071c12 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -192,6 +192,7 @@ To keep the Continue codebase clean and maintainable, we expect the following fr - Keep changes focused. Multiple unrelated fixes should be opened as separate PRs - Write or update tests for new functionality - Update relevant documentation in the `docs` folder +- **For new features**: Include a short screen recording or screenshot demonstrating the new functionality. This makes it much easier for us as contributors to review and understand your changes. See [this PR](https://github.com/continuedev/continue/pull/6455) as a good example - Open a PR against the `main` branch. Make sure to fill in the PR template ### Formatting