This repository has been archived by the owner on Aug 28, 2020. It is now read-only.
run through grammarly #135
Closed
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
|
|
hugovk
reviewed
Oct 6, 2018
There was a problem hiding this comment.
Be wary of Grammarly, it can make writing worse:
- https://www.chronicle.com/blogs/linguafranca/2012/08/01/these-cards-always-lie/
- https://www.economist.com/johnson/2012/08/01/automated-grammar-checking
- https://www.economist.com/johnson/2012/08/07/grammarly-revisited
- https://the-digital-reader.com/2017/05/04/im-breaking-grammarly/
- https://slate.com/technology/2018/02/grammarly-wont-make-your-writing-better.html
CODE_OF_CONDUCT.md
Outdated
| @@ -1,6 +1,6 @@ | |||
| # SendGrid Community Code of Conduct | |||
|
|
|||
| The SendGrid open source community is made up of members from around the globe with a diverse set of skills, personalities, and experiences. It is through these differences that our community experiences successes and continued growth. When you're working with members of the community, we encourage you to follow these guidelines, which help steer our interactions and strive to maintain a positive, successful and growing community. | |||
| The SendGrid open source community is made up of members from around the globe with a diverse set of skills, personalities, and experiences. It is through these differences that our community experiences successes and continued growth. When you're working with members of the community, we encourage you to follow these guidelines, which help steer our interactions and strive to maintain a positive, thriving and growing community. | |||
There was a problem hiding this comment.
I think this is less clear, it changes the meaning a bit.
CODE_OF_CONDUCT.md
Outdated
|
|
||
| ### Disclose Potential Conflicts of Interest | ||
| Community discussions often involve interested parties. We expect participants to be aware when they are conflicted due to employment or other projects they are involved in and disclose those interests to other project members. When in doubt, over-disclose. Perceived conflicts of interest are important to address so that the community’s decisions are credible even when unpopular, difficult or favorable to the interests of one group over another. | ||
| Community discussions often involve interested parties. We expect participants to be aware when they are conflicted due to employment or other projects they are involved in and disclose those interests to other project members. When in doubt, over-disclose. Perceived conflicts of interest are essential to address so that the community’s decisions are credible even when unpopular, difficult or favorable to the interests of one group over another. |
CONTRIBUTING.md
Outdated
| @@ -1,4 +1,4 @@ | |||
| Hello! Thank you for choosing to help contribute to one of the SendGrid open source projects. There are many ways you can contribute and help is always welcome. We simply ask that you follow the following contribution policies. | |||
| Hello! Thank you for choosing to help contribute to one of the SendGrid open source projects. There are many ways you can contribute and help is always welcome. We merely ask that you follow the following contribution policies. | |||
| @@ -11,14 +11,14 @@ Hello! Thank you for choosing to help contribute to one of the SendGrid open sou | |||
| - [Creating a Pull Request](#creating-a-pull-request) | |||
|
|
|||
| <a name="roadmap"></a> | |||
| We use [Milestones](https://github.com/sendgrid/open-source-library-data-collector/milestones) to help define current roadmaps, please feel free to grab an issue from the current milestone. Please indicate that you have begun work on it to avoid collisions. Once a PR is made, community review, comments, suggestions and additional PRs are welcomed and encouraged. | |||
| We use [Milestones](https://github.com/sendgrid/open-source-library-data-collector/milestones) to help define current roadmaps, please feel free to grab an issue from the current milestone. Please indicate that you have begun work on it to avoid collisions. Once a PR is made, community review, comments, suggestions, and additional PRs are welcomed and encouraged. | |||
There was a problem hiding this comment.
This is fine, the docs' style guide says to use Oxford commas.
https://github.com/sendgrid/docs/blob/develop/styleguide.md#punctuation
| @@ -33,20 +33,20 @@ If you'd like to make a feature request, please read this section. | |||
|
|
|||
| The GitHub issue tracker is the preferred channel for library feature requests, but please respect the following restrictions: | |||
|
|
|||
| - Please **search for existing issues** in order to ensure we don't have duplicate bugs/feature requests. | |||
| - Please **search for existing issues** to ensure we don't have duplicate bugs/feature requests. | |||
| - Please be respectful and considerate of others when commenting on issues | ||
|
|
||
| <a name="submit-a-bug-report"></a> | ||
| ## Submit a Bug Report | ||
|
|
||
| Note: DO NOT include your credentials in ANY code examples, descriptions, or media you make public. | ||
|
|
||
| A software bug is a demonstrable issue in the code base. In order for us to diagnose the issue and respond as quickly as possible, please add as much detail as possible into your bug report. | ||
| A software bug is a demonstrable issue in the code base. For us to diagnose the issue and respond as quickly as possible, please add as much detail as possible into your bug report. |
| @@ -149,7 +149,7 @@ All PRs require passing tests before the PR will be reviewed. | |||
|
|
|||
| All test files are in the [`test`](https://github.com/sendgrid/open-source-library-data-collector/tree/master/test) directory. | |||
|
|
|||
| For the purposes of contributing to this repo, please update the [`test.py`](https://github.com/sendgrid/open-source-library-data-collector/blob/master/test/test.py) file with unit tests as you modify the code. | |||
| To contribute to this repo, please update the [`test.py`](https://github.com/sendgrid/open-source-library-data-collector/blob/master/test/test.py) file with unit tests as you modify the code. | |||
| @@ -222,7 +222,7 @@ Please run your code through: | |||
|
|
|||
| 4. Commit your changes in logical chunks. Please adhere to these [git commit | |||
| message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) | |||
| or your code is unlikely be merged into the main project. Use Git's | |||
| or your code is unlikely to be merged into the main project. Use Git's | |||
|
@hugovk thank you for the feedback, please see the newest commit to address your comments. Thanks! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Resolves #134
Only a few changes were needed.
Fixes
Checklist
Short description of what this PR does:
If you have questions, please send an email to Sendgrid, or file a Github Issue in this repository.