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

Update CONTRIBUTING.md #527

Closed
wants to merge 1 commit into from
Closed

Update CONTRIBUTING.md #527

wants to merge 1 commit into from

Conversation

tgrecojs
Copy link

@tgrecojs tgrecojs commented Oct 31, 2017

Fixes

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:

Updated contributing.md for #525.

Changes made

  • Line 12 - Added Code Review Link
  • Line 232 - Added Code Review Header
  • Line 233 - Added text explaining how to perform code review.
    If you have questions, please send an email to Sendgrid, or file a Github Issue in this repository.

Updated contributing.md for sendgrid#525
@thinkingserious thinkingserious added the status: code review request requesting a community code review or review from Twilio label Oct 31, 2017
@SendGridDX
Copy link

SendGridDX commented Oct 31, 2017

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@gabrielkrell gabrielkrell left a comment

Choose a reason for hiding this comment

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

HTML link instead of Markdown. Otherwise looks fine.

@@ -228,4 +229,8 @@ Please run your code through:
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
with a clear title and description against the `master` branch. All tests must be passing before we will review the PR.

8. ## Code Reviews<a name="code-reviews"></a>
If you can, please look at open PRs and review them. Give feedback and help us merge these PRs much faster! If you don't know how, Github has some <a href="https://help.github.com/articles/about-pull-request-reviews/">great information on how to review a Pull Request.</a>
Copy link
Contributor

Choose a reason for hiding this comment

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

For the external link, Markdown syntax ([text](link)) might fit better with the rest of the document, although HTML technically works there. In this doc regular HTML is used for making standalone anchors like

<a name="roadmap"></a

because I believe there's no Markdown way to do it

(#roadmap)  <-- doesn't work

Copy link
Author

@tgrecojs tgrecojs Nov 1, 2017

Choose a reason for hiding this comment

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

@gabrielkrell i see.. so should i update the file with markdown? i see that this same way is being used on line 7 so i figured it was ok to use. i appreciate the feedback tho 😄 let me know what i need to do to update this

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, I would use markdown like:

... great information on [how to review a Pull Request](https://help.github.com/articles/about-pull-request-reviews/).

This PR might not be merged though because there was one submitted just before it that covers the same thing.

@gabrielkrell
Copy link
Contributor

Oops, this overlaps with #526.

@mbernier
Copy link
Contributor

mbernier commented Nov 3, 2017

@tgrecojs

We have not been able to merge your Pull Request, but because you are awesome - we wanted to make sure you could still get a SendGrid Hacktoberfest shirt.

Please go fill out our swag form before Nov 5th and we will send the shirt! (We know that you might have tried this before and it didn’t work, sorry about that!)

You have till Nov 5th to fill out this form in order to get the Hacktoberfest shirt!

Thank you for contributing during Hacktoberfest! We hope to see you in the repos soon! Just so you know, we always give away a SendGrid shirt for your first ever non-Hacktoberfest PR that gets merged.

@mbernier
Copy link
Contributor

@tgrecojs

If you are interested, we would love the opportunity to talk to you about Hacktoberfest and our API libraries.

Our agenda would be: Explore what you liked and is there anything we can do to improve?

You can grab a time on my calendar that works for you and we can have a chat on Google Hangout or Skype. If you prefer, you can email me using my GitHub username at my company’s domain.

Thank you so much,

Matt Bernier - @mbernier - SendGrid Developer Experience Product Manager
Elmer Thomas - @thinkingserious - SendGrid Developer Experience Engineer
@sendgrid

@mbernier mbernier closed this Dec 11, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: code review request requesting a community code review or review from Twilio
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants