Skip to content

Create CONTRIBUTING.md file#135

Merged
Xymph merged 2 commits intomasterfrom
contributing.md
Aug 31, 2021
Merged

Create CONTRIBUTING.md file#135
Xymph merged 2 commits intomasterfrom
contributing.md

Conversation

@waldyrious
Copy link
Copy Markdown
Collaborator

@waldyrious waldyrious commented Aug 29, 2021

  • Add CONTRIBUTING.md file
  • Format markdown files to break long lines and improve wording

For future reference, this PR was prompted by this discussion in #133.

@waldyrious waldyrious marked this pull request as draft August 29, 2021 18:47
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
@waldyrious waldyrious marked this pull request as ready for review August 29, 2021 21:22
@Xymph
Copy link
Copy Markdown
Collaborator

Xymph commented Aug 30, 2021

No remarks on contributing/governance/changelog.

In Usage, consider linefeeds at 58, 87, 185, 311;
and in Readme at 10-11, 19-20 and more (looks like you skipped it entirely).

@waldyrious
Copy link
Copy Markdown
Collaborator Author

Great suggestions for USAGE.md. I've applied them all. Same in the README. I hadn't really looked into lines that might need re-wrapping; I only handled lines that were already relatively long. I have now tried to locate other instances where re-wrapping might make sense.

As for lines 10-11 in the README, I'm not sure what wrapping would work better in your view (without breaking the sentence's clauses apart). I've moved the second sentence to its own line, but I can't think of a better way to wrap the first sentence. If anything, I could make it longer, by moving the "is v0.15.0," to the first line. Is this what you had in mind?

Copy link
Copy Markdown
Collaborator

@Xymph Xymph left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Almost there! 😃

Comment thread USAGE.md Outdated
Comment thread README.md
Also reword some passages for clarity, readability or consistency
@Xymph Xymph self-requested a review August 31, 2021 08:04
@Xymph
Copy link
Copy Markdown
Collaborator

Xymph commented Aug 31, 2021

And that's a wrap! 👍

@Xymph Xymph merged commit 0e7cdbe into master Aug 31, 2021
@waldyrious waldyrious deleted the contributing.md branch August 31, 2021 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants