diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,7 +33,10 @@ This means that there should be quick turnaround for patches to be proposed, reviewed, and committed. Changes should not sit in a queue for long. -Here are some tips to help keep the development working as intended: +Here are some tips to help keep the development working as intended. These +are guidelines for the normal and expected development process. Developers +can use their judgement to deviate from these guidelines when they have a +good reason to do so. - Keep each change small and self-contained. - Reach out for a 1-on-1 review so things move quickly. @@ -53,6 +56,8 @@ - Don't break the build, it is important to keep master green as much as possible. If a Diff is landed, and breaks the build, fix it quickly. If it cannot be fixed quickly, it should be reverted, and re-applied later when it no longer breaks the build. +- As soon as you see a bug, you fix it. Do not continue on. Fixing the bug becomes the +top priority, more important than completing other tasks. - Automate as much as possible, and spend time on things only humans can do. Here are some handy links for development practices aligned with Bitcoin ABC: @@ -64,6 +69,7 @@ - [Parallel Implementations](https://www.gamasutra.com/view/news/128325/Opinion_Parallel_Implementations.php) - [The Pragmatic Programmer: From Journeyman to Master](https://www.amazon.com/Pragmatic-Programmer-Journeyman-Master/dp/020161622X) - [Advantages of monolithic version control](https://danluu.com/monorepo/) +- [The importance of fixing bugs immediately]{https://youtu.be/E2MIpi8pIvY?t=16m0s} Getting set up with the Bitcoin ABC Repository