rfc:howto
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
rfc:howto [2021/08/14 11:02] – Update link to ML rules cmb | rfc:howto [2023/02/04 15:05] (current) – Added notes on not re-using RFC docs, and respecting authors danack | ||
---|---|---|---|
Line 12: | Line 12: | ||
- Log into the wiki with your wiki account. | - Log into the wiki with your wiki account. | ||
- Navigate to a URL like https:// | - Navigate to a URL like https:// | ||
- | - Push the "Create | + | - Push the "Edit this page" button, fill out the supplied [[rfc: |
- Edit https:// | - Edit https:// | ||
- Write the RFC. | - Write the RFC. | ||
Line 23: | Line 23: | ||
- Update your RFC page to " | - Update your RFC page to " | ||
- Add the doodle voting macro, for example: < | - Add the doodle voting macro, for example: < | ||
- | <doodle title=" | + | <doodle title=" |
* Yes | * Yes | ||
* No | * No | ||
Line 42: | Line 42: | ||
- Change its section on https:// | - Change its section on https:// | ||
+ | |||
+ | ==== Notes ==== | ||
+ | |||
+ | === Open new RFCs rather than re-use existing documents === | ||
+ | |||
+ | In general the status of an RFC should not be moved backwards to an earlier status. In practice there will be times when people accidentally open the voting too early, or some serious problem is found with an RFC during the voting phase, in those cases it's fine to move the status back until the problem is fixed. But as a rule, leaving each RFC document with a clear history of what happened to that RFC makes it easier to understand past discussions. | ||
+ | |||
+ | Also, we have rules about when RFCs are allowed to be put into voting. If a RFC document has been re-used there could be some confusion about when it is allowed to be put to a vote. | ||
+ | |||
+ | Leaving the previous RFC document intact, with the results of a vote if one was taken, leaves a clearer document trail than if the document has been recycled. | ||
+ | |||
+ | It can also be useful to create a new RFC document when an RFC changes significantly during it's discussion. Although previous versions of documents are available through the wiki, finding where an RFC was re-written and trying to understand why it was, are quite difficult. Leaving the previous version intact, with a note pointing to the new version makes understanding discussion history much easier. | ||
+ | |||
+ | === RFCs ' | ||
+ | |||
+ | Although minor typos can be fixed by other people, any significant changes should be approved by the original RFC author. | ||
+ | |||
+ | If you wish to 'take over' an RFC, you need the express consent of the RFC author. If you can't get that consent, for example the person doesn' | ||
+ | |||
+ | |||
+ | === Don't list someone as an author without their express consent === | ||
+ | |||
+ | There have been cases where someone has added someone' | ||
+ | |||
+ | If you want to credit someone for having done a large amount of work, e.g. when taking over an abandoned RFC, you can do that by adding the phrase 'based on work by' e.g. " | ||
==== External Resources ==== | ==== External Resources ==== | ||
* [[https:// | * [[https:// |
rfc/howto.1628938925.txt.gz · Last modified: 2021/08/14 11:02 by cmb