forked from coala/cEPs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add MarkdownBear and format existing .md
Closes coala#125
- Loading branch information
1 parent
bacab77
commit c1a4b7e
Showing
13 changed files
with
688 additions
and
560 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,15 @@ | ||
| coala Enhancement Proposals | ||
| =========================== | ||
| # coala Enhancement Proposals | ||
|
|
||
| |Metadata| | | ||
| |--------|-----------------------------------| | ||
| |cEP |0000 | | ||
| |Version |2.2 | | ||
| |Title |coala Enhancement Proposals | | ||
| |Authors |Lasse Schuirmann <[email protected]>| | ||
| |Status |Active | | ||
| |Type |Process | | ||
| | Metadata | | | ||
| | -------- | ------------------------------------------ | | ||
| | cEP | 0000 | | ||
| | Version | 2.2 | | ||
| | Title | coala Enhancement Proposals | | ||
| | Authors | Lasse Schuirmann <mailto:[email protected]> | | ||
| | Status | Active | | ||
| | Type | Process | | ||
|
|
||
| Abstract | ||
| -------- | ||
| ## Abstract | ||
|
|
||
| This cEP describes the introduction of cEP's (coala Enhancement Proposals) to | ||
| the coala community. | ||
|
|
@@ -23,8 +21,7 @@ features should not be implemented. | |
| They are obviously inspired by | ||
| [PEP1](https://www.python.org/dev/peps/pep-0001/). | ||
|
|
||
| Spelling | ||
| -------- | ||
| ## Spelling | ||
|
|
||
| As we all know, coala is written with a lower case c. The proper spelling of a | ||
| cEP is `cEP-[0-9]{4}([a-z])?`, so `cEP-####` or `cEP-####x`. | ||
|
|
@@ -34,8 +31,7 @@ author wants to. | |
| Invalid ways to express cEP specifications include `CEP-####`, `cEP####`, | ||
| `cep-####`, `Cep-####`, `CeP-####` and `CEp-####`. | ||
|
|
||
| Purpose | ||
| ------- | ||
| ## Purpose | ||
|
|
||
| cEP's are in place so features in coala will be designed before implementation. | ||
| Implementing major features usually happens from a technical perspective and | ||
|
|
@@ -45,8 +41,7 @@ oftentimes not well enough designed initially. | |
|
|
||
| This also makes sure, major features are properly documented. | ||
|
|
||
| Structure | ||
| --------- | ||
| ## Structure | ||
|
|
||
| Any cEP must at least hold the following information: | ||
|
|
||
|
|
@@ -55,8 +50,7 @@ Any cEP must at least hold the following information: | |
|
|
||
| Further chapters may be added as needed. | ||
|
|
||
| Metadata | ||
| -------- | ||
| ## Metadata | ||
|
|
||
| The metadata table must hold the following items: | ||
|
|
||
|
|
@@ -73,8 +67,7 @@ The metadata table must hold the following items: | |
| (for code changes), `Active`, `Deprecated` or `Rejected`. | ||
| - A **Type** which may be one of `Process` or `Feature`. | ||
|
|
||
| The Process | ||
| ----------- | ||
| ## The Process | ||
|
|
||
| Any process changes may be initiated by level B decisions as described in | ||
| cEP-1. | ||
|
|
@@ -122,11 +115,9 @@ A cEP may be rejected if the community determines. | |
|
|
||
| Follow up states are `Proposed`. | ||
|
|
||
| Patching cEP's | ||
| -------------- | ||
| ## Patching cEP's | ||
|
|
||
| cEP's may be changed. If a cEP is changed, the version number has to be | ||
| increased according to [semantic versioning](http://semver.org/). | ||
|
|
||
| Patching a cEP to a higher version can be done with a B level decision. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,20 @@ | ||
| Decision Making in coala | ||
| ======================== | ||
| # Decision Making in coala | ||
|
|
||
| |Metadata| | | ||
| |--------|--------------------------------------------------------------------| | ||
| |cEP |0001 | | ||
| |Version |2.0 | | ||
| |Title |Decision Making in coala | | ||
| |Authors |Maximilian Scholz <[email protected]>, Lasse Schuirmann <[email protected]>, Mischa Krüger <[email protected]>| | ||
| |Status |Active | | ||
| |Type |Process | | ||
| | Metadata | | | ||
| | -------- | ------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | cEP | 0001 | | ||
| | Version | 2.0 | | ||
| | Title | Decision Making in coala | | ||
| | Authors | Maximilian Scholz <mailto:[email protected]>, Lasse Schuirmann <mailto:[email protected]>, Mischa Krüger <mailto:[email protected]> | | ||
| | Status | Active | | ||
| | Type | Process | | ||
|
|
||
|
|
||
| Abstract | ||
| -------- | ||
| ## Abstract | ||
|
|
||
| This cEP describes the official roles members of the coala community can hold | ||
| and how they can vote on different levels of decisions. | ||
|
|
||
|
|
||
| Roles | ||
| ----- | ||
| ## Roles | ||
|
|
||
| The following roles can be held by members of the coala community: | ||
|
|
||
|
|
@@ -29,9 +24,9 @@ A newcomer is someone that was just introduced to the coala project and | |
| community and begins to contribute to it. This rank mainly represents the | ||
| learning phase of the contribution process. | ||
|
|
||
| Every org member that started following the [newcomer guide](//coala.io/newcomer) | ||
| is declared a newcomer by invitation into the GitHub organisation. Newcomers can | ||
| work on issues with an assignment. | ||
| Every org member that started following the [newcomer | ||
| guide](//coala.io/newcomer) is declared a newcomer by invitation into the GitHub | ||
| organisation. Newcomers can work on issues with an assignment. | ||
|
|
||
| ### Developer | ||
|
|
||
|
|
@@ -40,9 +35,9 @@ involved on a normal level and help with contributions and reviews on a | |
| semi-regular basis. | ||
|
|
||
| When a newcomer finished the newcomer guide they can ask a maintainer to be | ||
| promoted to a developer. A developer has all the rights of a newcomer but can be an | ||
| official coala team member and can use cobot to label issues and pull requests. | ||
| Developers also have voting rights on A level decisions. | ||
| promoted to a developer. A developer has all the rights of a newcomer but can be | ||
| an official coala team member and can use cobot to label issues and pull | ||
| requests. Developers also have voting rights on A level decisions. | ||
|
|
||
| If the contributions of a developer show the lack of fundamental understanding | ||
| of the coala workflow they can be demoted to the newcomer rank with a B level | ||
|
|
@@ -56,9 +51,10 @@ A Maintainer is someone that showed persistence in contributions and or an | |
| increased quality compared to a developer. They offer experience and passion for | ||
| the project and are granted full voting rights due to their achievements. | ||
|
|
||
| A developer can be promoted to a maintainer with a B level decision. This decision | ||
| does not have to be initiated by a maintainer so it is valid for a developer to | ||
| propose himself for a promotion. | ||
| A developer can be promoted to a maintainer with a B level decision. This | ||
| decision does not have to be initiated by a maintainer so it is valid for a | ||
| developer to propose himself for a promotion. | ||
|
|
||
| A maintainer has all the rights a developer has. Additionally maintainers have | ||
| write access to coala repositories, can promote newcomers and developers and | ||
| have voting rights on B and C level decisions. | ||
|
|
@@ -75,10 +71,9 @@ contributors to add their input to important decisions. | |
| The demotion from maintainer to developer represents a C level decision. It | ||
| should only be done if a maintainer has shown inactivity for prolonged periods | ||
| of time, half a year and upwards. | ||
| __This should not be used as a tool to silence unwanted opinions!__ | ||
| **This should not be used as a tool to silence unwanted opinions!** | ||
| Maintainers may choose to be demoted to developers at any time. | ||
|
|
||
|
|
||
| ### Benevolent Limited Dictator (BLD) | ||
|
|
||
| Members of the coala community have suggested the establishment of a Benevolent | ||
|
|
@@ -99,9 +94,7 @@ declares that person unwanted as a member of the coala community. | |
| This status stays active indefinitely but can be revoked at any point by a C | ||
| level decision. | ||
|
|
||
|
|
||
| Decision Types | ||
| -------------- | ||
| ## Decision Types | ||
|
|
||
| ### A Level Decision | ||
|
|
||
|
|
||
Oops, something went wrong.