New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added contributing guidelines and started tests as required by them #60

Merged
merged 1 commit into from Feb 5, 2014

Conversation

Projects
None yet
2 participants
@cirosantilli
Collaborator

cirosantilli commented Jan 19, 2014

No description provided.

@cirosantilli

This comment has been minimized.

Collaborator

cirosantilli commented Jan 19, 2014

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

This comment has been minimized.

Collaborator

ilikepi commented Jan 20, 2014

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

This comment has been minimized.

Collaborator

cirosantilli commented Jan 20, 2014

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

This comment has been minimized.

Collaborator

ilikepi commented Jan 20, 2014

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 ilikepi referenced this pull request Jan 29, 2014

Closed

All folds open initially #35

@ilikepi

This comment has been minimized.

Collaborator

ilikepi commented Feb 5, 2014

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

@cirosantilli

This comment has been minimized.

Collaborator

cirosantilli commented Feb 5, 2014

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

This comment has been minimized.

Collaborator

ilikepi commented Feb 5, 2014

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

This comment has been minimized.

Collaborator

cirosantilli commented Feb 5, 2014

@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

This comment has been minimized.

Collaborator

ilikepi commented Feb 5, 2014

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

@cirosantilli

This comment has been minimized.

Collaborator

cirosantilli commented Feb 5, 2014

Ok, I'm merging the new Gist version.

cirosantilli added a commit that referenced this pull request Feb 5, 2014

Merge pull request #60 from cirosantilli/contributing-guidelines
Added contributing guidelines and started tests as required by them

@cirosantilli cirosantilli merged commit bb8aeb1 into plasticboy:master Feb 5, 2014

@cirosantilli cirosantilli deleted the cirosantilli:contributing-guidelines branch Feb 5, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment