matrix/matrix-js-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-11-25 05:23:13 +03:00
Code Activity

Merge pull request #1933 from matrix-org/madlittlemods/more-better-pr-descriptions

Browse Source 
Update PR guidelines for easier review
This commit is contained in:
Eric Eastwood
2021-09-17 11:54:13 -05:00
committed by GitHub
parent e71362a6df 3705426b6d
commit 2bd60f4160
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@@ -22,8 +22,14 @@ ask you to make any refinements needed or merge it and make them ourselves.
Things that should go into your PR description: Things that should go into your PR description:
* A changelog entry in the `Notes` section (see below) * A changelog entry in the `Notes` section (see below)
* References to any bugs fixed by the change (in GitHub's `Fixes` notation) * References to any bugs fixed by the change (in GitHub's `Fixes` notation)
* Notes for the reviewer that might help them to understand why the change is * Describe the why and what is changing in the PR description so it's easy for
necessary or how they might better review it. onlookers and reviewers to onboard and context switch.
* Include both **before** and **after** screenshots to easily compare and discuss
what's changing.
* Include a step-by-step testing strategy so that a reviewer can check out the
code locally and easily get to the point of testing your change.
* Add comments to the diff for the reviewer that might help them to understand
why the change is necessary or how they might better understand and review it.
Things that should *not* go into your PR description: Things that should *not* go into your PR description:
* Any information on how the code works or why you chose to do it the way * Any information on how the code works or why you chose to do it the way