Pārlūkot izejas kodu

Document the design

Writing clarifies thinking and leaves behind guidance for future
maintainers.  Design descriptions shouldn't be required, though,
especially for trivial modules.
Mike Ashley 9 gadus atpakaļ
vecāks
revīzija
fced29f57e
1 mainītis faili ar 6 papildinājumiem un 1 dzēšanām
  1. 6
    1
      CONTRIBUTING.md

+ 6
- 1
CONTRIBUTING.md Parādīt failu

@@ -40,6 +40,12 @@ A module should be designed and implemented to run as quickly as possible in ord
40 40
 
41 41
 A module should have tests. TBD: more about this and what the expectation is.
42 42
 
43
+### Design document
44
+
45
+A module should have a design description explaining the approach to implementing a service and what tradeoffs were made when choosing the design that was implemented. Do not leave this for comments in a pull request as we want this close to the code for the sake of future maintainers.
46
+
47
+The design description should be succinct and to the point. Assume the reader is familiar with Sovereign but not your module. As a rule of thumb, 500-1000 words is about the right length for a module design description.
48
+
43 49
 ## Design checklist
44 50
 
45 51
 Consider the following checklist when reviewing a module's design.
@@ -52,4 +58,3 @@ Consider the following checklist when reviewing a module's design.
52 58
 ## Submitting pull requests
53 59
 
54 60
 When you issue a pull request, please specify what distribution you used for testing (if any).  Code that is committed to the master branch should work with both Debian 7 and Ubuntu 14.04 LTS.  Support for Debian 8 is coming.
55
-

Notiek ielāde…
Atcelt
Saglabāt