Skip to content

Commit 052aa6b

Browse files
authored
chore: Add logaf guide to CONTRIBUTING docs (#5985)
1 parent b34a37b commit 052aa6b

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,24 @@ When contributing to the codebase, please note:
8080

8181
- Non-trivial PRs will not be accepted without tests (see above).
8282
- Please do not bump version numbers yourself.
83-
- [`raven-js`](https://github.com/getsentry/sentry-javascript/tree/3.x/packages/raven-js) and [`raven-node`](https://github.com/getsentry/sentry-javascript/tree/3.x/packages/raven-node) are deprecated, and only bug and security fix PRs will be accepted targeting the [3.x branch](https://github.com/getsentry/sentry-javascript/tree/3.x). Any new features and improvements should be to our new SDKs (`browser`, `node`, and framework-specific packages like `react` and `nextjs`) and the packages which support them (`core`, `hub`, `integrations`, and the like).
83+
- [`raven-js`](https://github.com/getsentry/sentry-javascript/tree/3.x/packages/raven-js) and [`raven-node`](https://github.com/getsentry/sentry-javascript/tree/3.x/packages/raven-node) are deprecated, and only bug and security fix PRs will be accepted targeting the [3.x branch](https://github.com/getsentry/sentry-javascript/tree/3.x). Any new features and improvements should be to our new SDKs (`browser`, `node`, and framework-specific packages like `react` and `nextjs`) and the packages which support them (`core`, `utils`, `integrations`, and the like).
84+
85+
## PR reviews
86+
87+
For feedback in PRs, we use the [LOGAF scale](https://blog.danlew.net/2020/04/15/the-logaf-scale/) to specify how important a comment is:
88+
89+
* `l`: low - nitpick. You may address this comment, but you don't have to.
90+
* `m`: medium - normal comment. Worth addressing and fixing.
91+
* `h`: high - Very important. We must not merge this PR without addressing this issue.
92+
93+
You only need one approval from a maintainer to be able to merge. For some PRs, asking specific or multiple people for review might be adequate.
94+
95+
Our different types of reviews:
96+
97+
1. **LGTM without any comments.** You can merge immediately.
98+
2. **LGTM with low and medium comments.** The reviewer trusts you to resolve these comments yourself, and you don't need to wait for another approval.
99+
3. **Only comments.** You must address all the comments and need another review until you merge.
100+
4. **Request changes.** Only use if something critical is in the PR that absolutely must be addressed. We usually use `h` comments for that. When someone requests changes, the same person must approve the changes to allow merging. Use this sparingly.
84101

85102
## Publishing a Release
86103

0 commit comments

Comments
 (0)