Skip to content
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

fixed changes suggested by grammarly #640

Merged
merged 4 commits into from
Oct 30, 2018

Conversation

xeon-zolt
Copy link
Contributor

Fixes #639

Checklist

  • I have made a material change to the repo (functionality, testing, spelling, grammar)
  • I have read the [Contribution Guide] and my PR follows them.
  • I updated my branch with the master branch.
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation about the functionality in the appropriate .md file
  • I have added in line documentation to the code I modified

Short description of what this PR does:

  • made changes in files as suggested by Grammarly app
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
│   ├── README.md
│   └── USAGE.md
│   └── README.md
│   └── mail-helper-refactor.md
├── README.md
│   │   │   ├── README.md
│   │   │   ├── README.md
│   │       ├── README.md
├── TROUBLESHOOTING.md
├── USAGE.md
    ├── asynchronous_mail_send.md
    ├── attachment.md
    ├── aws.md
    ├── django.md
    ├── domain_whitelabel.md
    ├── email_stats.md
    ├── error_handling.md
    ├── flask_heroku.md
    ├── README.md
    ├── slack_event_api_integration.md
    └── transational_templates.md

@thinkingserious thinkingserious added the status: code review request requesting a community code review or review from Twilio label Oct 5, 2018
@SendGridDX
Copy link

SendGridDX commented Oct 5, 2018

CLA assistant check
All committers have signed the CLA.

@codecov
Copy link

codecov bot commented Oct 5, 2018

Codecov Report

Merging #640 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #640   +/-   ##
=======================================
  Coverage   85.03%   85.03%           
=======================================
  Files          35       35           
  Lines        1156     1156           
  Branches      172      172           
=======================================
  Hits          983      983           
  Misses         90       90           
  Partials       83       83

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cedb4cc...5599acf. Read the comment docs.

@misterdorm misterdorm added status: work in progress Twilio or the community is in the process of implementing hacktoberfest difficulty: medium fix is medium in difficulty and removed status: code review request requesting a community code review or review from Twilio labels Oct 11, 2018
Copy link
Contributor

@misterdorm misterdorm left a comment

Choose a reason for hiding this comment

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

Thanks for picking this up! I've left several comments for nuances not picked up by Grammar.ly that should be reverted or changed to something else.

### Be Respectful
Members of the community are respectful. We're respectful of others, their positions, their skills, their commitments and their efforts. We're respectful of the volunteer efforts that permeate the SendGrid community. We're respectful of the processes outlined in the community, and we work within them. When we disagree, we are courteous in raising our issues. Overall, we're good to each other. We contribute to this community not because we have to, but because we want to. If we remember that, these guidelines will come naturally.

Members of the community are respectful. We're respectful of others, their positions, their skills, their commitments ,and their efforts. We're respectful of the volunteer efforts that permeate the SendGrid community. We're respectful of the processes outlined in the community, and we work within them. When we disagree, we are courteous in raising our issues. Overall, we're good with each other. We contribute to this community not because we have to, but because we want to. If we remember that, these guidelines will come naturally.
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: Misplaced space around comma at "commitments ,and their efforts."

CONTRIBUTING.md Outdated
contain your feature, change, or fix:

```bash
git checkout -b <topic-branch-name>
```

4. Commit your changes in logical chunks. Please adhere to these [git commit
4. Commit your changes in logical chunks. Please adhere to these [git commits
Copy link
Contributor

Choose a reason for hiding this comment

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

'commit' in this context is a noun, not a verb. Trailing 's' not needed.

@@ -95,7 +95,7 @@ If you are using a [requirements file](https://pip.readthedocs.io/en/1.1/require
<a name="versions"></a>
## Versioning Convention

We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with to your code and never auto-update to the latest version. Especially when there is a MAJOR point release, since that is guaranteed to be a breaking change. Changes are documented in the [CHANGELOG](https://github.com/sendgrid/sendgrid-python/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-python/releases) section.
We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with your code and never auto-update to the latest version. Especially when there is a MAJOR point release since that is guaranteed to be a breaking change. Changes are documented in the [CHANGELOG](https://github.com/sendgrid/sendgrid-python/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-python/releases) section.
Copy link
Contributor

Choose a reason for hiding this comment

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

Change to "...working with in your code...", feels more natural than the original "to your code". But only removing 'to' is not appropriate.

USAGE.md Outdated
@@ -70,7 +70,4628 @@ IP Access Management allows you to control which IP addresses can be used to acc

For more information, please see our [User Guide](http://sendgrid.com/docs/User_Guide/Settings/ip_access_management.html).

### POST /access_settings/whitelist
Copy link
Contributor

Choose a reason for hiding this comment

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

Was this change a mistake?

use_cases/aws.md Outdated
@@ -2,14 +2,14 @@

This tutorial explains how to set up a simple "Hello Email" app on AWS, using the AWS CodeStar service.

We'll be creating a basic web service to send email via SendGrid. The application will run on AWS Lambda, and the "endpoint" will be via AWS API Gateway.
We'll be creating a basic web service to send an email via SendGrid. The application will run on AWS Lambda, and the "endpoint" will be via AWS API Gateway.
Copy link
Contributor

Choose a reason for hiding this comment

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

'email' is plural in this context, 'an' not needed.

use_cases/aws.md Outdated

Once that's done, you've successfully created a CodeStar project! You should be at the dashboard, with a view of the wiki, change log, build pipeline, and application endpoint.
Once that's done, you've successfully created a CodeStar project! You should be at the dashboard, with a view of the wiki, changelog, build a pipeline, and application endpoint.
Copy link
Contributor

Choose a reason for hiding this comment

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

'build' is a noun in this context, 'a' not needed.

use_cases/aws.md Outdated
Congratulations, you've just used serverless technology to create an email sending the app in AWS!
Copy link
Contributor

Choose a reason for hiding this comment

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

'sending' is noun here, 'the' not needed.

@@ -1,4 +1,4 @@
# Create a Django app to send email with SendGrid
# Create a Django app to send an email with SendGrid
Copy link
Contributor

Choose a reason for hiding this comment

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

'email' is plural, 'an' not needed.

@@ -119,7 +119,7 @@ $ python manage.py migrate
$ python manage.py runserver
```

By default, it starts the development server at `http://127.0.0.1:8000/`. To test if we can send email or not, go to `http://127.0.0.1:8000/sendgrid/`. If it works, we should see the page says "Email Sent!".
By default, it starts the development server at `http://127.0.0.1:8000/`. To test if we can send an email or not, go to `http://127.0.0.1:8000/sendgrid/`. If it works, we should see the page says "Email Sent!".
Copy link
Contributor

Choose a reason for hiding this comment

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

'email' is plural, 'an' not needed.

@@ -1,4 +1,4 @@
# Create a Flask app to send email with SendGrid
# Create a Flask app to send an email with SendGrid
Copy link
Contributor

Choose a reason for hiding this comment

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

'email' is plural, 'an' not needed.

@misterdorm
Copy link
Contributor

Thanks @xeon-zolt ! Could you please address/explain the large amount of changes to USAGE.md?

@xeon-zolt
Copy link
Contributor Author

@misterdorm please check again

Copy link
Contributor

@misterdorm misterdorm left a comment

Choose a reason for hiding this comment

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

Thanks!

@thinkingserious
Copy link
Contributor

Hello @xeon-zolt,

Could you please resolve the merge conflicts? Thank you!

With Best Regards,

Elmer

@thinkingserious
Copy link
Contributor

Hello @xeon-zolt,

Thanks again for the PR!

It's HACKTOBERFEST! We want to show our appreciation by sending you some special Hacktoberfest swag. If you have not already, could you please fill out this form so we can send it to you? Thanks!

Team SendGrid DX

@thinkingserious
Copy link
Contributor

Hello @xeon-zolt,

Thanks again for the PR!

We noticed that you have earned 3 out of the 5 points needed to receive glorious SendGrid Hacktoberfest swag.

Please take a moment to checkout this link to find more issues to get you past the required threshold.

Also, please be sure that you have officially registered here.

Thank you and Happy Hacktobering!

Team SendGrid DX

@thinkingserious thinkingserious merged commit 90cfbf2 into sendgrid:master Oct 30, 2018
@thinkingserious
Copy link
Contributor

Hello @xeon-zolt,

Thanks again for the PR!

You have earned 3 out of the 5 points needed to receive glorious SendGrid Hacktoberfest swag.

Please take a moment to checkout this link to find more issues to get you past the required threshold or to simply continue the celebration.

Also, please be sure you have officially registered with us here by November 1, 2018 to qualify.

If you have any questions you can email us at [email protected].

Thank you and Happy Hacktobering!

Team SendGrid

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: medium fix is medium in difficulty status: work in progress Twilio or the community is in the process of implementing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Run our *.md documents in this repo through the Grammer.ly service and update
4 participants