New SWIP process - complete remake #53
Conversation
just contains new proposal as an update to README. If accepted, should follow with complience changes
README.md
Outdated
| * **Deferred** - a SWIP that is not being considered for immediate adoption. May be reconsidered in the future. | ||
| ```yaml | ||
| --- | ||
| title: fairx |
There was a problem hiding this comment.
This example title is concise, but not descriptive. I suggest taking one of the existing as example:
Neighbourhood hopping
README.md
Outdated
|
|
||
| For a detailed description of the SWIP process see [SWIP-0](SWIPs/swip-0.md). | ||
| A new SWIP can be proposed by opening a PR in the [SWIP repo](https://github.com/ethersphere/SWIPs) titled `SWIP-<XXXX>: <title>` where `XXXX` is the SWIP number left padded with zeros up to four digits (i.e., fprinted with the format string `%04d`). |
There was a problem hiding this comment.
To avoid clashes on SWIP numbers, let us define that a SWIP must have the same number as the PR.
Also, I would be against left padding with zeros to make it for digits, as I see no need for that. The number will grow to more than four digits. And also, the practice in Ethereum is there is no padding (example https://eips.ethereum.org/all).
There was a problem hiding this comment.
OK then. Then it is no longer relevant to merge the claim PR early on, it simplifies the process.
The need for XXXX numbering is solely the neat temporally correct listing of SWIP md files
There was a problem hiding this comment.
@crtahlin How about we don't use /assets/SWIP-XXXX/ subdirectories, rather a global assets directory to enable shared figures?
There was a problem hiding this comment.
I would say that each SWIP should have their own folder of assets for easier reference and browsing within the SWIP. If in the future we see the need for having shared assets among the SWIPs, we can have a global one.
README.md
Outdated
|
|
||
| ### Updating a SWIP | ||
|
|
||
| A suggested edit to a SWIP can be proposed by opening a PR in the [SWIP repo](https://github.com/ethersphere/SWIPs) with a PR title in the following format: `Update SWIP-XXXX: Title of the suggested change`. |
There was a problem hiding this comment.
This is for an edit of a SWIP that is already final / accepted? As a draft SWIP should be just edited directly?
There was a problem hiding this comment.
Actually, reading forward, it is for a SWIP that is merged but can be in any state?
|
|
||
| Once a phase of a SWIPs is complete, authors will indicate this by setting the `ready to merge` label on the open PR. editors can merge the PR to master. see also section about curating SWIPs below. | ||
|
|
||
| ### Format and structure |
There was a problem hiding this comment.
Should the template SWIP (https://github.com/ethersphere/SWIPs/blob/master/SWIPs/swip-X.md) still be used? I guess not, since there are sections and headers defined in this README.
fix typo, change example title
README.md
Outdated
|
|
||
| For a detailed description of the SWIP process see [SWIP-0](SWIPs/swip-0.md). | ||
| A new SWIP can be proposed by opening a PR in the [SWIP repo](https://github.com/ethersphere/SWIPs) titled `SWIP-<XXXX>: <title>` where `XXXX` is the SWIP number left padded with zeros up to four digits (i.e., fprinted with the format string `%04d`). | ||
| The PR is adding at least a new placeholder file for the new proposal named `XXXX.md` to be located in the `SWIPs` subdirectory of the SWIPs repo. |
There was a problem hiding this comment.
Let's also define the name format here, like: swip-xx.md (where xx is the number of the PR, as discussed above)
|
Please review @zelig 🐝 |
just contains new proposal as an update to README.
If accepted, should follow with complience changes