docs: improve readability of contribute.md (issue #37) #40
Conversation
This file contains hidden or 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
Signed-off-by: Reed <reedjmerrill@gmail.com>
✅ Deploy Preview for mlsysops ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Hi @ReedMerrill! thanks very much for your patch! Looks good, and is inline with what we had in mind. I'm adding the necessary labels to allow the CI to run, please feel free to coordinate with @RR-Sahoo at #37 so that we can avoid merge conflicts. thanks! |
Contributor
Author
|
@ananos Please let me know if there is anything else I need to do for this PR! |
Contributor
|
thanks @ReedMerrill I'm keen to merge this as it fixes stuff. However there's more work to be done in the contributing document so feel free to tackle this on a follow-up PR. thanks so much for your contributions! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This change involves a variety of edits to improve readability, including removing repetitive text, improving spelling and grammar, and improvements to convey the same meaning in fewer words.
I started with
contribute.mdto see if this is the sort of readability improvements you are looking for. I'll be happy to work on more long documentation like this too and I'm looking forward to your feedback.