Skip to content

Commit c1a4b7e

Browse files
blazeugitmate-bot
blazeu
authored and
gitmate-bot
committed
Add MarkdownBear and format existing .md
Closes #125
1 parent bacab77 commit c1a4b7e

File tree

13 files changed

+688
-560
lines changed

13 files changed

+688
-560
lines changed

‎.coafile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ files = **.md
33
use_spaces = yeah
44
bears = SpaceConsistencyBear
55

6+
[markdown]
7+
files = **.md
8+
bears = MarkdownBear
9+
610
[commits]
711
bears = GitCommitBear
812
shortlog_regex = ([^:]*|[^:]+: [A-Z0-9*].*)

‎README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,17 @@ This repository holds coala Enhancement Proposals. You can read more about them
44
in the `cEP-0000.md` document.
55

66
## Index
7-
| Filename | Title | Description |
8-
|-----------------------|-------------------|-----------------------------------------------------|
9-
| [cEP-0000](cEP-0000.md) | coala Enhancement Proposals | This cEP describes the official roles members of the coala community can hold and how they can vote on different levels of decisions.|
10-
|[cEP-0001](cEP-0001.md) | Decision Making in coala | This cEP describes the official roles members of the coala community can hold and how they can vote on different levels of decisions. |
11-
| [cEP-0002](cEP-0002.md) | Next Gen Bear Design | This cEP describes a new implementation of bears in coala which should make them simpler and make their design more intuitive and better. |
12-
| [cEP-0003](cEP-0003.md) | Teams in coala|This is a proposal on how to decentralize the management of coala by introducing teams. |
13-
| [cEP-0005](cEP-0005.md) | coala Configuration|One main pain point for our users is that coala is hard to configure. |
14-
| [cEP-0006](cEP-0006.md) | coala Community Code of Conduct | Like the technical community as a whole, the coala team and community is made up of a mixture of professionals and volunteers from all over the world,working on every aspect of the mission - including mentorship, teaching, and connecting people. |
15-
| [cEP-0009](cEP-0009.md) | Change status | This cEP proposes a mechanism to represent and extract information from project files and an interface to utilize the extracted information. |
16-
| [cEP-0010](cEP-0010.md) |Convert bears to use aspects | This document describes how `aspects` will be defined for and connected with bears and how their results will be annotated with them. |
17-
| [cEP-0012](cEP-0012.md) | coala's Command Line Interface|This cEP describes the design of coala's Command Line Interface (the action selection screen). |
18-
| [cEP-0013](cEP-0013.md) | Cobot Enhancement and porting|This cEP describes about the new features that are to be added to cobot as a part of the [GSoC project](https://summerofcode.withgoogle.com/projects/#4913450777051136). |
19-
| [cEP-0014](cEP-0014.md) | Generate relevant coafile sections | This cEP proposes a framework for coala-quickstart to generate more relevant `.coafile` sections based on project files and user preferences. |
7+
8+
| Filename | Title | Description |
9+
| ----------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
10+
| [cEP-0000](cEP-0000.md) | coala Enhancement Proposals | This cEP describes the official roles members of the coala community can hold and how they can vote on different levels of decisions. |
11+
| [cEP-0001](cEP-0001.md) | Decision Making in coala | This cEP describes the official roles members of the coala community can hold and how they can vote on different levels of decisions. |
12+
| [cEP-0002](cEP-0002.md) | Next Gen Bear Design | This cEP describes a new implementation of bears in coala which should make them simpler and make their design more intuitive and better. |
13+
| [cEP-0003](cEP-0003.md) | Teams in coala | This is a proposal on how to decentralize the management of coala by introducing teams. |
14+
| [cEP-0005](cEP-0005.md) | coala Configuration | One main pain point for our users is that coala is hard to configure. |
15+
| [cEP-0006](cEP-0006.md) | coala Community Code of Conduct | Like the technical community as a whole, the coala team and community is made up of a mixture of professionals and volunteers from all over the world,working on every aspect of the mission - including mentorship, teaching, and connecting people. |
16+
| [cEP-0009](cEP-0009.md) | Change status | This cEP proposes a mechanism to represent and extract information from project files and an interface to utilize the extracted information. |
17+
| [cEP-0010](cEP-0010.md) | Convert bears to use aspects | This document describes how `aspects` will be defined for and connected with bears and how their results will be annotated with them. |
18+
| [cEP-0012](cEP-0012.md) | coala's Command Line Interface | This cEP describes the design of coala's Command Line Interface (the action selection screen). |
19+
| [cEP-0013](cEP-0013.md) | Cobot Enhancement and porting | This cEP describes about the new features that are to be added to cobot as a part of the [GSoC project](https://summerofcode.withgoogle.com/projects/#4913450777051136). |
20+
| [cEP-0014](cEP-0014.md) | Generate relevant coafile sections | This cEP proposes a framework for coala-quickstart to generate more relevant `.coafile` sections based on project files and user preferences. |

‎cEP-0000.md

Lines changed: 16 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
1-
coala Enhancement Proposals
2-
===========================
1+
# coala Enhancement Proposals
32

4-
|Metadata| |
5-
|--------|-----------------------------------|
6-
|cEP |0000 |
7-
|Version |2.2 |
8-
|Title |coala Enhancement Proposals |
9-
|Authors |Lasse Schuirmann <[email protected]>|
10-
|Status |Active |
11-
|Type |Process |
3+
| Metadata | |
4+
| -------- | ------------------------------------------ |
5+
| cEP | 0000 |
6+
| Version | 2.2 |
7+
| Title | coala Enhancement Proposals |
8+
| Authors | Lasse Schuirmann <mailto:[email protected]> |
9+
| Status | Active |
10+
| Type | Process |
1211

13-
Abstract
14-
--------
12+
## Abstract
1513

1614
This cEP describes the introduction of cEP's (coala Enhancement Proposals) to
1715
the coala community.
@@ -23,8 +21,7 @@ features should not be implemented.
2321
They are obviously inspired by
2422
[PEP1](https://www.python.org/dev/peps/pep-0001/).
2523

26-
Spelling
27-
--------
24+
## Spelling
2825

2926
As we all know, coala is written with a lower case c. The proper spelling of a
3027
cEP is `cEP-[0-9]{4}([a-z])?`, so `cEP-####` or `cEP-####x`.
@@ -34,8 +31,7 @@ author wants to.
3431
Invalid ways to express cEP specifications include `CEP-####`, `cEP####`,
3532
`cep-####`, `Cep-####`, `CeP-####` and `CEp-####`.
3633

37-
Purpose
38-
-------
34+
## Purpose
3935

4036
cEP's are in place so features in coala will be designed before implementation.
4137
Implementing major features usually happens from a technical perspective and
@@ -45,8 +41,7 @@ oftentimes not well enough designed initially.
4541

4642
This also makes sure, major features are properly documented.
4743

48-
Structure
49-
---------
44+
## Structure
5045

5146
Any cEP must at least hold the following information:
5247

@@ -55,8 +50,7 @@ Any cEP must at least hold the following information:
5550

5651
Further chapters may be added as needed.
5752

58-
Metadata
59-
--------
53+
## Metadata
6054

6155
The metadata table must hold the following items:
6256

@@ -73,8 +67,7 @@ The metadata table must hold the following items:
7367
(for code changes), `Active`, `Deprecated` or `Rejected`.
7468
- A **Type** which may be one of `Process` or `Feature`.
7569

76-
The Process
77-
-----------
70+
## The Process
7871

7972
Any process changes may be initiated by level B decisions as described in
8073
cEP-1.
@@ -122,11 +115,9 @@ A cEP may be rejected if the community determines.
122115

123116
Follow up states are `Proposed`.
124117

125-
Patching cEP's
126-
--------------
118+
## Patching cEP's
127119

128120
cEP's may be changed. If a cEP is changed, the version number has to be
129121
increased according to [semantic versioning](http://semver.org/).
130122

131123
Patching a cEP to a higher version can be done with a B level decision.
132-

‎cEP-0001.md

Lines changed: 23 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,20 @@
1-
Decision Making in coala
2-
========================
1+
# Decision Making in coala
32

4-
|Metadata| |
5-
|--------|--------------------------------------------------------------------|
6-
|cEP |0001 |
7-
|Version |2.0 |
8-
|Title |Decision Making in coala |
9-
|Authors |Maximilian Scholz <[email protected]>, Lasse Schuirmann <[email protected]>, Mischa Krüger <[email protected]>|
10-
|Status |Active |
11-
|Type |Process |
3+
| Metadata | |
4+
| -------- | ------------------------------------------------------------------------------------------------------------------------------------- |
5+
| cEP | 0001 |
6+
| Version | 2.0 |
7+
| Title | Decision Making in coala |
8+
| Authors | Maximilian Scholz <mailto:[email protected]>, Lasse Schuirmann <mailto:[email protected]>, Mischa Krüger <mailto:[email protected]> |
9+
| Status | Active |
10+
| Type | Process |
1211

13-
14-
Abstract
15-
--------
12+
## Abstract
1613

1714
This cEP describes the official roles members of the coala community can hold
1815
and how they can vote on different levels of decisions.
1916

20-
21-
Roles
22-
-----
17+
## Roles
2318

2419
The following roles can be held by members of the coala community:
2520

@@ -29,9 +24,9 @@ A newcomer is someone that was just introduced to the coala project and
2924
community and begins to contribute to it. This rank mainly represents the
3025
learning phase of the contribution process.
3126

32-
Every org member that started following the [newcomer guide](//coala.io/newcomer)
33-
is declared a newcomer by invitation into the GitHub organisation. Newcomers can
34-
work on issues with an assignment.
27+
Every org member that started following the [newcomer
28+
guide](//coala.io/newcomer) is declared a newcomer by invitation into the GitHub
29+
organisation. Newcomers can work on issues with an assignment.
3530

3631
### Developer
3732

@@ -40,9 +35,9 @@ involved on a normal level and help with contributions and reviews on a
4035
semi-regular basis.
4136

4237
When a newcomer finished the newcomer guide they can ask a maintainer to be
43-
promoted to a developer. A developer has all the rights of a newcomer but can be an
44-
official coala team member and can use cobot to label issues and pull requests.
45-
Developers also have voting rights on A level decisions.
38+
promoted to a developer. A developer has all the rights of a newcomer but can be
39+
an official coala team member and can use cobot to label issues and pull
40+
requests. Developers also have voting rights on A level decisions.
4641

4742
If the contributions of a developer show the lack of fundamental understanding
4843
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
5651
increased quality compared to a developer. They offer experience and passion for
5752
the project and are granted full voting rights due to their achievements.
5853

59-
A developer can be promoted to a maintainer with a B level decision. This decision
60-
does not have to be initiated by a maintainer so it is valid for a developer to
61-
propose himself for a promotion.
54+
A developer can be promoted to a maintainer with a B level decision. This
55+
decision does not have to be initiated by a maintainer so it is valid for a
56+
developer to propose himself for a promotion.
57+
6258
A maintainer has all the rights a developer has. Additionally maintainers have
6359
write access to coala repositories, can promote newcomers and developers and
6460
have voting rights on B and C level decisions.
@@ -75,10 +71,9 @@ contributors to add their input to important decisions.
7571
The demotion from maintainer to developer represents a C level decision. It
7672
should only be done if a maintainer has shown inactivity for prolonged periods
7773
of time, half a year and upwards.
78-
__This should not be used as a tool to silence unwanted opinions!__
74+
**This should not be used as a tool to silence unwanted opinions!**
7975
Maintainers may choose to be demoted to developers at any time.
8076

81-
8277
### Benevolent Limited Dictator (BLD)
8378

8479
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.
9994
This status stays active indefinitely but can be revoked at any point by a C
10095
level decision.
10196

102-
103-
Decision Types
104-
--------------
97+
## Decision Types
10598

10699
### A Level Decision
107100

0 commit comments

Comments
 (0)