Skip to content

Commit 068c169

Browse files
author
Sam Harrison
committed
docs: clean up and reconcile first timers documentation
1 parent 9f9fab8 commit 068c169

File tree

2 files changed

+33
-35
lines changed

2 files changed

+33
-35
lines changed

FIRST_TIMERS.md

Lines changed: 33 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,59 @@
11
# How To Contribute to Twilio SendGrid Repositories via GitHub
2+
Contributing to the Twilio SendGrid repositories is easy! All you need to do is find an open issue (see the bottom of this page for a list of repositories containing open issues), fix it and submit a pull request. Once you have submitted your pull request, the team can easily review it before it is merged into the repository.
23

3-
Contributing to the Twilio SendGrid is easy! All you need to do is find an open issue (see the bottom of this page for a list of repositories containing open issues), fix it and submit a pull request. Once you have submitted your pull request, the team can easily review it before it is merged into the repository.
44
To make a pull request, follow these steps:
55

66
1. Log into GitHub. If you do not already have a GitHub account, you will have to create one in order to submit a change. Click the Sign up link in the upper right-hand corner to create an account. Enter your username, password, and email address. If you are an employee of Twilio SendGrid, please use your full name with your GitHub account and enter Twilio SendGrid as your company so we can easily identify you.
7-
<img src="/static/img/github-signup.png" width="800">
8-
2. **[Fork](https://help.github.com/fork-a-repo/)** the [csharp-http-client](https://github.com/sendgrid/csharp-http-client) repository:
97

10-
<img src="/static/img/github-fork.png" width="800">
11-
12-
3. __Clone__ your fork via the following commands:
13-
14-
```bash
15-
# Clone your fork of the repo into the current directory
16-
git clone https://github.com/your_username/csharp-http-client
8+
<img src="/static/img/github-sign-up.png" width="800">
179

18-
# Navigate to the newly cloned directory
19-
cd csharp-http-client
10+
2. __[Fork](https://help.github.com/fork-a-repo/)__ the [csharp-http-client](https://github.com/sendgrid/csharp-http-client) repository:
2011

21-
# Assign the original repo to a remote called "upstream"
22-
git remote add upstream https://github.com/sendgrid/csharp-http-client
12+
<img src="/static/img/github-fork.png" width="800">
2313

14+
3. __Clone__ your fork via the following commands:
15+
16+
```bash
17+
# Clone your fork of the repo into the current directory
18+
git clone https://github.com/your_username/csharp-http-client
19+
# Navigate to the newly cloned directory
20+
cd csharp-http-client
21+
# Assign the original repo to a remote called "upstream"
22+
git remote add upstream https://github.com/sendgrid/csharp-http-client
2423
```
24+
2525
> Don't forget to replace *your_username* in the URL by your real GitHub username.
2626
27-
4. __Create a new topic branch__ (off the main project development branch) to
28-
contain your feature, change, or fix:
29-
```
27+
4. __Create a new topic branch__ (off the main project development branch) to contain your feature, change, or fix:
3028

29+
```bash
3130
git checkout -b <topic-branch-name>
32-
33-
```
34-
5. __Commit your changes__ in logical chunks. Please adhere to these [git commit
35-
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
36-
or your code is unlikely be merged into the main project. Use Git's
37-
[interactive rebase](https://help.github.com/articles/interactive-rebase)
38-
feature to tidy up your commits before making them public. Probably you will also have to create tests (if needed) or create or update the example code that demonstrates the functionality of this change to the code.
39-
6. __Locally merge (or rebase)__ the upstream development branch into your topic branch:
4031
```
4132

42-
git pull [--rebase] upstream main
33+
5. __Commit your changes__ in logical chunks.
34+
35+
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 [interactive rebase](https://help.github.com/articles/interactive-rebase) feature to tidy up your commits before making them public. Probably you will also have to create tests (if needed) or create or update the example code that demonstrates the functionality of this change to the code.
4336

37+
6. __Locally merge (or rebase)__ the upstream development branch into your topic branch:
38+
39+
```bash
40+
git pull [--rebase] upstream main
4441
```
42+
4543
7. __Push__ your topic branch up to your fork:
46-
```
4744

45+
```bash
4846
git push origin <topic-branch-name>
49-
5047
```
51-
8. __[Open a Pull Request](https://help.github.com/articles/creating-a-pull-request/#changing-the-branch-range-and-destination-repository/)__
52-
with a clear title and description against the `main` branch. All tests must be passing before we will review the PR.
53-
### Important notice
54-
Before creating a pull request, make sure that you respect the repository's constraints regarding contributions. You can find them in the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
48+
49+
8. __[Open a Pull Request](https://help.github.com/articles/creating-a-pull-request/#changing-the-branch-range-and-destination-repository/)__ with a clear title and description against the `main` branch. All tests must be passing before we will review the PR.
50+
51+
## Important notice
52+
53+
Before creating a pull request, make sure that you respect the repository's constraints regarding contributions. You can find them in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
54+
5555
## Repositories with Open, Easy, Help Wanted, Issue Filters
56+
5657
* [Python SDK](https://github.com/sendgrid/sendgrid-python/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
5758
* [PHP SDK](https://github.com/sendgrid/sendgrid-php/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
5859
* [C# SDK](https://github.com/sendgrid/sendgrid-csharp/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
@@ -73,9 +74,6 @@ Before creating a pull request, make sure that you respect the repository's cons
7374
* [Java HTTP Client](https://github.com/sendgrid/java-http-client/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
7475
* [Ruby HTTP Client](https://github.com/sendgrid/ruby-http-client/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
7576
* [Go HTTP Client](https://github.com/sendgrid/rest/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
76-
* [Node.js HTTP Client](https://github.com/sendgrid/nodejs-http-client/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
77-
* [Open Source Data Collector](https://github.com/sendgrid/open-source-library-data-collector/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
7877
* [Open API Definition](https://github.com/sendgrid/sendgrid-oai/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
7978
* [DX Automator](https://github.com/sendgrid/dx-automator/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
8079
* [Documentation](https://github.com/sendgrid/docs/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
81-
```
File renamed without changes.

0 commit comments

Comments
 (0)