Added contributing guidelines and started tests as required by them

[cirosantilli]

No description provided.

[cirosantilli]

Please review this as contributing guidelines are very important for a project.

If no one respondes, I will merge the PR in 14 days. We can change the guidelines at any point in the future.

[ilikepi]

Excellent. I think this is a great start to a welcome addition. Assuming this ends up merged, it would seem beneficial to resolve any lingering issues with the original Markdown spec test document (you have denoted two I believe), and then move on to adding test documents for other flavors.

👍

[cirosantilli]

Fixed the typos.
Agree that it would be better to solve existing issues before merge, or at least one so that new contributors can follow a template.
We should make here a list of existing features that do not comply to the ideal CONTRIBUTING guidelines.
So far I can see:

• add tests for every single feature of the original markdown specs
• no on off option for fenced code blocks extension
• no tests for mappings (I wrote the current mappings, so assign this to self)

[ilikepi]

Well, we could also merge this particular change into a separate branch. That way, the outstanding issues could be addressed in separate pull requests against that branch before the contribution guidelines were formally introduced to the project.

[ilikepi]

Should probably move forward with this now that it's been open a couple weeks...

[cirosantilli]

Do you mean we can merge as is?

I have been trying to get some time to further improve this, but work has been crazy...

[ilikepi]

Well, I think the actual content is reasonably spelled out. The only change I might suggest at this point might be to tighten up the formatting of the CONTRIBUTING.md file, and maybe expand the failed test example. I tweaked your file and posted it to this gist.

The rules themselves can be tweaked over time as needed of course. I think it would be good to get something out there to start, though.

[cirosantilli]

@ilikepi On your Gist where you joined lines you left 2 spaces instead of 1. Was it intentional? It does not seem to have any effect on GFM, and as far as I know should not have any effect on standard markdown (except if followed by a newline).

Otherwise it seems good to me.

[ilikepi]

Oh, no, it's just an outdated habit I'm too stubborn to try to fix. I have updated the gist.

[cirosantilli]

Ok, I'm merging the new Gist version.