Skip to content
This repository was archived by the owner on Aug 8, 2023. It is now read-only.

Add documenting PRs #36

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add documenting PRs #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,14 @@ the root folder. Minimum viable documentation includes:

[_Draft your documentation before committing any code!_](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html)

Document code changes. It is important to document the changes in pull requests in order to help us recall the reasons behind decisions. Every pull request should have a clear description includes:

* Purpose of the changes
* List of major changes
* Steps to reproduce and verify

When closing a pull request, write down the reasons of why the pull request is rejected.

#### Be solutions focused

- Rather than thinking "Wow, I can name 20 things that are awful with this design", try to be solutions focused. "There are 20 improvements we could make to this! X is done this way, but it could be better if we made it more like Y". There are many reasons why a piece of software was built the way it was built, and harping on how it was built doesn't get us any closer to solving the problem at hand.
Expand Down