Add MarkdownBear and format existing .md #128
Conversation
| | cEP | 0000 | | ||
| | Version | 2.2 | | ||
| | Title | coala Enhancement Proposals | | ||
| | Authors | Lasse Schuirmann <mailto:[email protected]> | |
There was a problem hiding this comment.
Not sure if we want this, since GitHub already highlight email without mailto:
but MarkdownBear enforces this
There was a problem hiding this comment.
There's this bug coala/coala-bears#1235 which can usually be avoided by installing the correct packages and version of remark. Also, coala/coala-bears#2131 (comment) which can be confusing as hell, upstream bug and needs more testing. |
| ## Code Samples | ||
|
|
||
| ### Collecting extracted information from project | ||
|
|
||
| <!-- Start ignoring MarkdownBear --> |
There was a problem hiding this comment.
Maybe a bug, it wants to add more and more indentation to the codeblocks below.
cEP-0014.md
Outdated
| @@ -410,7 +545,8 @@ def aggregate_info(infoextractors): | |||
| ``` | |||
|
|
|||
| ### Collecting all the meta-data | |||
| ```py | |||
|
|
|||
| ````py | |||
There was a problem hiding this comment.
4 backticks? I don't understand the reason.
There was a problem hiding this comment.
Agree strange.
You intended to put an Start ignoring.. here?
There was a problem hiding this comment.
Okay, replaced it with 3 and MarkdownBear didn't complain
| shortlog(and the the first character following the colon if there is one) | ||
| given the value of | ||
| <!-- Ignore MarkdownBear --> | ||
| `Root.Metadata.CommitMessage.Shortlog.FirstCharacter.shortlog_starts_upper_case` |
There was a problem hiding this comment.
MarkdownBear wants to warp inline codeblock, this doesn't happen with remark-lint@6, but MarkdownBear is using v5.
| | 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]> | |
There was a problem hiding this comment.
this is going to be annoying when another author is added.
markdown tables suck
There was a problem hiding this comment.
Make it 1 author per line?
There was a problem hiding this comment.
then we get into variations of markdown.
not worth it atm.
IMO we propose a change to cEP 0 to replace .md with .asciidoc or rst.
cEP-0001.md
Outdated
| have voting rights on B and C level decisions. | ||
| 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 |
There was a problem hiding this comment.
add an extra blank line before A maintainer .. - that preserves the intent a bit better IMO
cEP-0014.md
Outdated
| @@ -410,7 +545,8 @@ def aggregate_info(infoextractors): | |||
| ``` | |||
|
|
|||
| ### Collecting all the meta-data | |||
| ```py | |||
|
|
|||
| ````py | |||
There was a problem hiding this comment.
Agree strange.
You intended to put an Start ignoring.. here?
|
ack 3ab92ca |
|
@gitmate-bot rebase |
|
Hey! I'm GitMate.io! This pull request is being rebased automatically. Please DO NOT push while rebase is in progress or your changes would be lost permanently |
|
Automated rebase with GitMate.io was successful! 🎉 |
|
reack c1a4b7e |
|
@gitmate-bot ff |
|
Hey! I'm GitMate.io! This pull request is being fastforwarded automatically. Please DO NOT push while fastforward is in progress or your changes would be lost permanently |
|
Automated fastforward with GitMate.io was successful! 🎉 |
|
I tried running the mark-down bear locally, but it reports errors in other cEP's as well I used |
|
@virresh can you open an issue please? |
|
@blazeu I realised I was using coala's development version Although even the pre-release on pip doesn't work well with MarkDown bear |
Default MarkdownBear style used.
Probably need CI.
Closes #125