Improve/expand contribution instructions #7
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
waldyrious
force-pushed
the
contribution-instructions
branch
from
267be71
to
f981bf1
Compare
Use typographically correct, curved quote symbols instead of the straight ones. Co-authored-by: rugk <[email protected]>
|
I've added the suggested changes, @rugk — thanks for the review and feedback, and sorry it took me so long to respond each time! Since nobody else offered feedback in over a month, I'll go ahead and merge :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prompted by the discussion in #6 (comment), and based on my own exploration of this repository in the course of various cleanup changes I've been making, here are some updates to the contribution documentation to clarify some ambiguous bits, add extra information, fix a some typos, and overall make this project slightly easier to contribute to.
This is an important step towards making the project ready for moving to an organization to be community-maintained, as it cements some practices and guidelines that were not yet fully fleshed out.
I'll leave this PR open for a few days in case there's any feedback. I'd be happy to hear others' opinions on whether the updated text is clear and useful enough. /cc @cassidyjames who started the discussion linked above, as well as @rugk and @CaKrome, who reacted in #2.