From f7b49c3e6ae06205163ff37556501e7e5ff01bec Mon Sep 17 00:00:00 2001 From: Arseniy Klempner Date: Mon, 21 Jul 2025 13:53:45 -0700 Subject: [PATCH] feat: add guidelines for large PRs --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 66f51d5397..40eca50b55 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -63,6 +63,12 @@ Commit messages should never contain any `@` mentions (usernames prefixed with " Please refer to the [Git manual](https://git-scm.com/doc) for more information about Git. +### Structuring Large PRs for Efficient Review + +Pull requests should be as atomic as possible, but sometimes we need to make large changes across the entire codebase. For these cases it's best to maintain a commit history as you make changes, giving the reviewer the option to read changes all at once or per commit. + +If a code change is focused on one or two files but introduces coalescing changes across the rest of the codebase, it's best to point out the core changes as a starting point for reviewers to properly understand the other changes. This can be part of the PR description. + ### Releasing `js-waku` has two types of releases: