3diy
/
klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Update wording of "quality improvement" section of CONTRIBUTING.md 

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2022-04-08 09:56:22 -04:00
parent 5a409d5d31
commit 7c5b7191c3
1 changed files with 13 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/CONTRIBUTING.md
View File

@ -93,21 +93,19 @@ Common things a reviewer will look for:
real-world benefits of a change is a natural part of a review. real-world benefits of a change is a natural part of a review.
When discussing benefits it is preferable to discuss "facts and When discussing benefits it is preferable to discuss "facts and
measurements" instead of "opinions and theories". In general, measurements". In general, reviewers are not looking for responses
reviewers are not looking for responses of the form "this of the form "someone may find option X useful", nor are they
submission may improve quality because of ...", nor are they looking for responses of the form "this submission adds a feature
looking for responses of the form "someone may find option X that firmware X implements". Instead, it is generally preferable to
useful", nor are they looking for responses of the form "this discuss details on how the quality improvement was measured and
submission adds a feature that firmware X implements". Instead, it what were the results of those measurements - for example, "tests
is generally preferable to discuss details on how the quality on Acme X1000 printers show improved corners as seen in picture
improvement was measured and what were the results of those ...", or for example "print time of real-world object X on a
measurements - for example, "tests on Acme X1000 printers show Foomatic X900 printer went from 4 hours to 3.5 hours". It is
improved corners as seen in picture ...", or for example "print understood that testing of this type can take significant time and
time of real-world object X on a Foomatic X900 printer went from 4 effort. Some of Klipper's most notable features took months of
hours to 3.5 hours". It is understood that testing of this type can discussion, rework, testing, and documentation prior to being
take significant time and effort. Some of Klipper's most notable merged into the master branch.
features took years of discussion, rework, testing, and
documentation prior to being merged into the master branch.
All new modules, config options, commands, command parameters, and All new modules, config options, commands, command parameters, and
documents should have "high impact". We do not want to burden users documents should have "high impact". We do not want to burden users