logos-messaging/js-waku
1
0
Fork 0
mirror of https://github.com/logos-messaging/js-waku.git synced 2026-01-02 13:53:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: add guidelines for large PRs

Browse Source
This commit is contained in:
Arseniy Klempner 2025-07-21 13:53:45 -07:00
parent c24842a4a5
commit f7b49c3e6a
No known key found for this signature in database
GPG Key ID: 51653F18863BD24B
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -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: