Compare commits
1
Commits
next
..
f791823d10
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f791823d10 |
@@ -30,18 +30,17 @@ These rules MUST be followed at all times. This is very important.
|
|||||||
|
|
||||||
- When fixing a bug, write a failing test for the bug FIRST. Add appropriate
|
- When fixing a bug, write a failing test for the bug FIRST. Add appropriate
|
||||||
logging to the test, to make sure the test is written correctly. Commit that.
|
logging to the test, to make sure the test is written correctly. Commit that.
|
||||||
Then work on the fix until the test passes, without changing the test further.
|
Then fix the bug until the test passes, without modifying the test further.
|
||||||
Then commit the fix.
|
Then commit the fix.
|
||||||
|
|
||||||
- When adding a new feature, do the same: write a test first (test-driven
|
- When adding a new feature, do the same: write a test first (test-driven
|
||||||
development, TDD). The test does not need to be very complex. Commit the test,
|
development, TDD). The test does not need to be very complex. Commit the test,
|
||||||
then commit the feature.
|
then commit the feature.
|
||||||
|
|
||||||
- When adding a new feature, use a feature branch. The feature branch reaches
|
- When adding a new feature, use a feature branch. The feature branch is merged
|
||||||
`next` through a PR that passes review. It is merged only when the feature is
|
into `next`, and then deleted, only when the feature is completely finished
|
||||||
completely finished and the code is up to standards. The code is up to
|
and the code is up to standards. The code is up to standards when it passes
|
||||||
standards when it passes `make check`. The branch is deleted after the merge.
|
`make check`. Only the user merges `next` into `main`.
|
||||||
Only the user merges `next` into `main`.
|
|
||||||
|
|
||||||
- Write `godoc` comments for all exported types and functions as you go along.
|
- Write `godoc` comments for all exported types and functions as you go along.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user