Shorten CONTRIBUTING.md

[sthiele]

As discussed in Issue #33 a proposal for a much condensed CONTRIBUTING.md

[rkaminsk]

Maybe we should have a vote which one to take? I personally don't care much.

Put 👀 for the old one and a 🎉 for the new one.

If you have strong arguments why one is better than the other drop some comments.

[javier-romero]

Hi, I have no experience at all on this so I won't vote, but I feel that:

• in the template it is better to have the reduced version, since the other is overkill to me
• it would still be good to have a link in the reduced version to the extended version (that should be somewhere accessible) since it can be useful to some people

[rkaminsk]

Hi, I have no experience at all on this so I won't vote, but I feel that:

* in the template it is better to have the reduced version, since the other is overkill to me

I prefer short readmes. I think that for a contributing guide it is not as important to be concise.

Things to consider:

• An experienced programmer is only interested in whether PRs are accepted and what form they should have. The short version tells him that PRs are accepted.
• An inexperienced programmer does not get much information.

* it would still be good to have a link in the reduced version to the extended version (that should be somewhere accessible) since it can be useful to some people

So far we do not have a general contributing guide for the organization and I am not sure we should have one.

[rkaminsk]

@sthiele what about this little extension?

[sthiele]

@rkaminsk How about this?

[rkaminsk]

Maybe we should also try to find a markdown auto formatter. I like to read markdown in my text editor.

[rkaminsk]

I found the formatters:

• https://github.com/executablebooks/mdformat
• https://prettier.io/

And these linters:

• https://github.com/jackdewinter/pymarkdown
• https://github.com/markdownlint/markdownlint
• https://github.com/igorshubovych/markdownlint-cli

All of them bring precommit hooks. mdformat seems nice and simple.

[sthiele]

Maybe we should also try to find a markdown auto formatter. I like to read markdown in my text editor.

I use https://github.com/DavidAnson/vscode-markdownlint.
It does not restrict line width ... my editor can do dynamic line wrapping 😛

[sthiele]

Under the hood it uses https://github.com/DavidAnson/markdownlint-cli2

[rkaminsk]

Maybe we should also try to find a markdown auto formatter. I like to read markdown in my text editor.

I use https://github.com/DavidAnson/vscode-markdownlint. It does not restrict line width ... my editor can do dynamic line wrapping 😛

Mine too. I just added mdformat and I like what it does. 😄