Skip to content

Commit aaf2823

Browse files
devin-ai-integration[bot]tom.vanlaerhoven
andcommitted
Add REVIEW.md with code review guidelines
Co-Authored-By: tom.vanlaerhoven <tom.vanlaerhoven@dolby.com>
1 parent 05858a1 commit aaf2823

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

REVIEW.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Code Review Guidelines
2+
3+
## Tone
4+
5+
- Be **very** concise.
6+
- Thank the PR author.
7+
8+
## Review format
9+
10+
Start every review with a short poem that begins with an emoji. The poem should be inspired by the changes in the PR.
11+
12+
## Changelog
13+
14+
Every PR that changes runtime behavior **must** include a corresponding entry in `CHANGELOG.md` under `## [Unreleased]`.
15+
16+
The format follows [Keep a Changelog](http://keepachangelog.com/en/1.1.0/):
17+
18+
```md
19+
## [Unreleased]
20+
21+
### Added
22+
- Added support for feature X on platform Y.
23+
24+
### Fixed
25+
- Fixed an issue on Android where Z was not working.
26+
```
27+
28+
If no changelog entry was added, suggest one and give the author the ability to simply **confirm & commit**.
29+
30+
Documentation-only changes do **not** require a changelog entry.
31+
32+
## CI / E2E tests
33+
34+
Some e2e tests are flaky. If tests fail, rerun them — unless the failure is a **build error**, in which case it should be investigated.
35+
36+
## Labels
37+
38+
Add relevant labels to the PR if they are missing.

0 commit comments

Comments
 (0)