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

Contributing.md broken links fix #779

Merged

Conversation

arshadkazmi42
Copy link
Contributor

@arshadkazmi42 arshadkazmi42 commented Oct 6, 2018

Fixes #781

Checklist

  • [ x] I have made a material change to the repo (functionality, testing, spelling, grammar)
  • [ x] I have read the [Contribution Guide] and my PR follows them.
  • [ x] 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:

  • Fixed USAGE link
  • Fixed USE_CASE link
  • Fixed esdoc link

If you have questions, please send an email to Sendgrid, or file a Github Issue in this repository.

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

SendGridDX commented Oct 6, 2018

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@reedsa reedsa 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 your contribution! I've added a comment for your consideration.

CONTRIBUTING.md Outdated
@@ -81,7 +81,7 @@ npm install

First, get your free SendGrid account [here](https://sendgrid.com/free?source=sendgrid-nodejs).

You will need to setup the following environment to use the SendGrid examples in the [README.md](https://github.com/sendgrid/sendgrid-nodejs/blob/master/README.md), [USAGE.md](https://github.com/sendgrid/sendgrid-nodejs/blob/master/USAGE.MD) and [USE_CASES.md](https://github.com/sendgrid/sendgrid-nodejs/blob/master/USE_CASES.md) files:
You will need to setup the following environment to use the SendGrid examples in the [README.md](https://github.com/sendgrid/sendgrid-nodejs/blob/master/README.md), [USAGE.md](https://github.com/sendgrid/sendgrid-nodejs/blob/master/USAGE.md) and [USE_CASES](https://github.com/sendgrid/sendgrid-nodejs/blob/master/use-cases/README.md) files:
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should use relative links in our docs to have GH link to the proper file based on whatever branch someone might be viewing from. https://blog.github.com/2013-01-31-relative-links-in-markup-files/

Also not sure about removing .md from the link, or maybe instead remove .md from all for consistency.

@reedsa reedsa added status: waiting for feedback waiting for feedback from the submitter and removed status: code review request requesting a community code review or review from Twilio labels Oct 10, 2018
@arshadkazmi42
Copy link
Contributor Author

@reedsa thank you for the review, updated links to relative links.

@reedsa reedsa added status: ready for deploy code ready to be released in next deploy and removed status: waiting for feedback waiting for feedback from the submitter labels Oct 11, 2018
@devchas devchas added the status: work in progress Twilio or the community is in the process of implementing label Oct 17, 2018
@thinkingserious thinkingserious added hacktoberfest difficulty: easy fix is easy in difficulty type: docs update documentation change not affecting the code and removed status: work in progress Twilio or the community is in the process of implementing labels Oct 22, 2018
@thinkingserious thinkingserious merged commit e0e2e58 into sendgrid:master Oct 22, 2018
@arshadkazmi42 arshadkazmi42 deleted the contributing-broken-link branch October 23, 2018 03:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: easy fix is easy in difficulty status: ready for deploy code ready to be released in next deploy type: docs update documentation change not affecting the code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix broken link in CONTRIBUTING.md
5 participants