diff options
author | Isis Lovecruft <isis@torproject.org> | 2017-11-20 18:27:47 +0000 |
---|---|---|
committer | Isis Lovecruft <isis@torproject.org> | 2017-12-08 01:53:52 +0000 |
commit | 8be6722e8d901304f6795fcf97c02c0f45bca98e (patch) | |
tree | 3217331d152cb65cb93848eeea5b40527ab0e251 /proposals/001-process.txt | |
parent | c78806e96eed6828873c6f9604f2a89d14fc123d (diff) | |
download | torspec-8be6722e8d901304f6795fcf97c02c0f45bca98e.tar.gz torspec-8be6722e8d901304f6795fcf97c02c0f45bca98e.zip |
Require a "Ticket:" field for future proposals in certain states.
New proposals in states {OPEN,ACCEPTED,CLOSED,FINISHED} must have a
"Ticket:" field which may either be a ticket number or a publicly
accessible URL. When the ticket is just a number, it should be in
reference to Tor's canonical bug tracker.
This information greatly helps both new contributors and relay
operators who are interested in the implementation status of a working
proposal. This patch permits the "Ticket:" field to be added to older
proposals (<= prop#288), but it does not require it.
Diffstat (limited to 'proposals/001-process.txt')
-rw-r--r-- | proposals/001-process.txt | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/proposals/001-process.txt b/proposals/001-process.txt index ba65211..1da80da 100644 --- a/proposals/001-process.txt +++ b/proposals/001-process.txt @@ -85,11 +85,19 @@ What should go in a proposal: Filename, Title, Author, Created, Status. These fields are optional but recommended: - Target, Implemented-In. + Target, Implemented-In, Ticket**. + The Target field should describe which version the proposal is hoped to be implemented in (if it's Open or Accepted). The Implemented-In field should describe which version the proposal was implemented in (if it's - Finished or Closed). + Finished or Closed). The Ticket field should be a ticket number referring + to Tor's canonical bug tracker (e.g. "#7144" refers to + https://bugs.torproject.org/7144) or to a publicly accessible URI where one + may subscribe to updates and/or retrieve information on implementation + status. + + ** Proposals with assigned numbers of prop#283 and higher are REQUIRED to + have a Ticket field if the Status is OPEN, ACCEPTED, CLOSED, or FINISHED. The body of the proposal should start with an Overview section explaining what the proposal's about, what it does, and about what state it's in. |