You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: FIRST_TIMERS.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
-[Setting up the Development Environment](#setup)
7
7
-[Proposing Change through a Pull Request](#pr)
8
8
-[Be Patient & Wait for reviews](#reviews)
9
-
9
+
10
10
<aname="explore"></a>
11
11
### Explore Twilio SendGrid
12
12
Step 1: Get yourself Access to Twilio SendGrid API Service absolutely free from [here](https://sendgrid.com/free/?source=sendgrid-python)\
@@ -15,8 +15,8 @@ Step 2: Get familiar with Twilio SendGrid Service
15
15
- Set up your [Twilio SendGrid API Key](https://app.sendgrid.com/settings/api_keys) to your local workspace [using](https://github.com/sendgrid/sendgrid-python#setup-environment-variables)
16
16
- Install Twilio SendGrid to your workspace using `pip install sendgrid`
17
17
- Copy & Run few sample programs from [here](https://github.com/sendgrid/sendgrid-python#hello-email)
18
-
19
-
18
+
19
+
20
20
<aname="issues"></a>
21
21
### Raise Issues
22
22
Twilio SendGrid uses GitHub as the content management service so, all the issues related to the project be it some feature request or a bug report, all are reported at the [GitHub Issue Tracker](https://github.com/sendgrid/sendgrid-python/issues)\
@@ -27,16 +27,16 @@ Step 2: Get familiar with Twilio SendGrid Service
27
27
If you encounter any sort of bug or abnormal behavior, feel free to inform the community after performing the following checks:
28
28
- Update to the latest version & check if the bug persists
29
29
- Check the Issue Tracker for any similar bug report
30
-
30
+
31
31
Finally fill up the Bug Report Template & Open the Issue highlighting your encountered bug & detailed steps to regenerate the bug.
32
-
32
+
33
33
<aname="setup"></a>
34
34
### Setting up the Development Environment
35
35
-**Using Docker**\
36
36
Use our Docker image to avoid setting up the development environment yourself. See [USAGE.md](https://github.com/sendgrid/sendgrid-python/blob/master/docker/USAGE.md)
37
-
37
+
38
38
-**Setting up Locally**\
39
-
Step 1: Install the Prerequistes: Any Version of Python(2.6 through 3.6) & [python_http_client](https://github.com/sendgrid/python-http-client)\
39
+
Step 1: Install the Prerequistes: Any Version of Python(2.6 through 3.6) and both [python_http_client](https://github.com/sendgrid/python-http-client) and [ecdsa_python](https://github.com/starkbank/ecdsa-python)\
40
40
Step 2: Get a local copy of repository using `git clone https://github.com/sendgrid/sendgrid-python.git`\
41
41
Step 3: Set your [Twilio SendGrid API Key](https://app.sendgrid.com/settings/api_keys) to your local workspace using\
@@ -46,28 +46,28 @@ Step 2: Get familiar with Twilio SendGrid Service
46
46
-**/examples** contains *Working examples that demonstrate usage*
47
47
-**/tests** contains *the unit and profiling tests*
48
48
-**/sendgrid** contains *the Web API v3 client ie sendgrid.py and other files*.
49
-
50
-
49
+
50
+
51
51
<aname="pr"></a>
52
52
## Proposing Change through a Pull Request
53
53
**Step 1:** Fork the project & Clone your fork using `git clone https://github.com/<USERNAME>/sendgrid-python.git`
54
-
54
+
55
55
**Step 2:** Reconfigure the remotes using `cd sendgrid-python` and `git remote add upstream https://github.com/sendgrid/sendgrid-python.git`
56
-
56
+
57
57
**Step 3:** Create a new branch for your modifications using `git checkout -b <topic-branch-name>`
58
-
58
+
59
59
**Step 4:** Commit the changes in logical chunks & add commit messages strictly following [this](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
60
-
60
+
61
61
**Step 5:** Run all test locally, [for more info](https://github.com/sendgrid/sendgrid-python/blob/master/CONTRIBUTING.md#testing)
62
-
62
+
63
63
**Step 6:** Locally merge your the upstream development branch into your topic-branch using `git pull [--rebase] upstream master`
64
-
64
+
65
65
**Step 7:** Push the topic branch up to your fork using `git push origin <topic-branch-name>`
66
-
66
+
67
67
**Step 8:** Open a Pull Request with clear title and description against the master branch.
68
68
69
69
<aname="reviews"></a>
70
70
## Be Patient & Wait for Reviews
71
71
Kindly be patient & follow the suggestions as provided by the peer reviewers. Make required amendments & changes to the PR as asked.
72
-
72
+
73
73
## [Explore New Issues to work upon](https://github.com/sendgrid/sendgrid-python/labels/difficulty%3A%20easy)
0 commit comments