Problem: hard to quickly identify the status of a specification

Solution: specify color-coded badges
This commit is contained in:
Yurii Rashkovskii 2016-06-03 10:19:25 +07:00
parent 28e776209e
commit 276a8949f5
7 changed files with 20 additions and 1 deletions

View File

@ -1,8 +1,10 @@
![stable](../2/stable.svg)
The Collective Code Construction Contract (C4) is an evolution of the github.com [Fork + Pull Model](http://help.github.com/send-pull-requests/), aimed at providing an optimal collaboration model for free software projects. This is revision 2 of the C4 specification.
* Name: rfc.unprotocols.org/spec:1/C4 (1/C4)
* Editor: Pieter Hintjens <ph@imatix.com>
* State: stable
* Status: stable
This RFC is equivalent (with the exception of minor cosmetic changes) to [ZeroMQ RFC 42/C4](http://rfc.zeromq.org/spec:42)

View File

@ -1,3 +1,5 @@
![draft](draft.svg)
This document describes a consensus-oriented specification system (COSS) for building interoperable technical specifications. COSS is based on a lightweight editorial process that seeks to engage the widest possible range of interested parties and move rapidly to consensus through working code.
* Name: rfc.unprotocols.org/spec:2/COSS (2/COSS)
@ -135,3 +137,13 @@ Where possible editors and contributors are encouraged to:
* Refer to and build on existing work when possible, especially IETF specifications.
* Contribute to existing specifications rather than reinvent their own.
* Use collaborative branching and merging as a tool for experimentation.
## Appendix A. Color Coding
It is RECOMMENDED to use color coding to indicate specification's status. Color coded specifications SHOULD use the following color scheme:
* ![raw](raw.svg)
* ![draft](draft.svg)
* ![stable](stable.svg)
* ![deprecated](deprecated.svg)
* ![retired](retired.svg)

1
2/deprecated.svg Normal file
View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="114" height="20"><g shape-rendering="crispEdges"><path fill="#555" d="M0 0h43v20H0z"/><path fill="#a4a61d" d="M43 0h71v20H43z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11"><text x="22.5" y="14">status</text><text x="77.5" y="14">deprecated</text></g></svg>

After

Width:  |  Height:  |  Size: 366 B

1
2/draft.svg Normal file
View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="80" height="20"><g shape-rendering="crispEdges"><path fill="#555" d="M0 0h43v20H0z"/><path fill="#007ec6" d="M43 0h37v20H43z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11"><text x="22.5" y="14">status</text><text x="60.5" y="14">draft</text></g></svg>

After

Width:  |  Height:  |  Size: 360 B

1
2/raw.svg Normal file
View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="74" height="20"><g shape-rendering="crispEdges"><path fill="#555" d="M0 0h43v20H0z"/><path fill="#9f9f9f" d="M43 0h31v20H43z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11"><text x="22.5" y="14">status</text><text x="57.5" y="14">raw</text></g></svg>

After

Width:  |  Height:  |  Size: 358 B

1
2/retired.svg Normal file
View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="90" height="20"><g shape-rendering="crispEdges"><path fill="#555" d="M0 0h43v20H0z"/><path fill="#e05d44" d="M43 0h47v20H43z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11"><text x="22.5" y="14">status</text><text x="65.5" y="14">retired</text></g></svg>

After

Width:  |  Height:  |  Size: 362 B

1
2/stable.svg Normal file
View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="86" height="20"><g shape-rendering="crispEdges"><path fill="#555" d="M0 0h43v20H0z"/><path fill="#4c1" d="M43 0h43v20H43z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11"><text x="22.5" y="14">status</text><text x="63.5" y="14">stable</text></g></svg>

After

Width:  |  Height:  |  Size: 358 B