Skip to content

Commit d4983da

Browse files
authored
Merge pull request #6606 from continuedev/pe/contributing-docs-update
docs: add note about demos on PRs
2 parents 1a9458c + be7a773 commit d4983da

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

.github/pull_request_template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
- [] The relevant docs, if any, have been updated or created
99
- [] The relevant tests, if any, have been updated or created
1010

11-
## Screenshots
11+
## Screen recording or screenshot
1212

13-
[ For visual changes, include screenshots. Screen recordings are particularly helpful, and appreciated! ]
13+
[ 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. ]
1414

1515
## Tests
1616

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,7 @@ To keep the Continue codebase clean and maintainable, we expect the following fr
192192
- Keep changes focused. Multiple unrelated fixes should be opened as separate PRs
193193
- Write or update tests for new functionality
194194
- Update relevant documentation in the `docs` folder
195+
- **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
195196
- Open a PR against the `main` branch. Make sure to fill in the PR template
196197

197198
### Formatting

0 commit comments

Comments
 (0)