Skip to content

Commit 66f23b2

Browse files
author
childish-sambino
authored
docs: baseline all the templated markdown docs (#865)
1 parent 04a06d8 commit 66f23b2

12 files changed

+153
-99
lines changed

.github/ISSUE_TEMPLATE

-17
This file was deleted.

.github/PULL_REQUEST_TEMPLATE

-25
This file was deleted.

CODE_OF_CONDUCT.md

+64-29
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,73 @@
1-
# Twilio SendGrid Community Code of Conduct
2-
3-
The Twilio SendGrid open source community is made up of members from around the globe with a diverse set of skills, personalities, and experiences. It is through these differences that our community experiences successes and continued growth. When you're working with members of the community, we encourage you to follow these guidelines, which help steer our interactions and strive to maintain a positive, successful and growing community.
4-
5-
### Be Open
6-
Members of the community are open to collaboration, whether it's on pull requests, code reviews, approvals, issues or otherwise. We're receptive to constructive comments and criticism, as the experiences and skill sets of all members contribute to the whole of our efforts. We're accepting of all who wish to take part in our activities, fostering an environment where anyone can participate, and everyone can make a difference.
1+
# Contributor Covenant Code of Conduct
72

8-
### Be Considerate
9-
Members of the community are considerate of their peers, which include other contributors and users of Twilio SendGrid. We're thoughtful when addressing the efforts of others, keeping in mind that often the labor was completed with the intent of the good of the community. We're attentive in our communications, whether in person or online, and we're tactful when approaching differing views.
3+
## Our Pledge
104

11-
### Be Respectful
12-
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 Twilio 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.
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
1311

14-
## Additional Guidance
12+
## Our Standards
1513

16-
### Disclose Potential Conflicts of Interest
17-
Community discussions often involve interested parties. We expect participants to be aware when they are conflicted due to employment or other projects they are involved in and disclose those interests to other project members. When in doubt, over-disclose. Perceived conflicts of interest are important to address so that the community’s decisions are credible even when unpopular, difficult or favorable to the interests of one group over another.
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
1816

19-
### Interpretation
20-
This Code is not exhaustive or complete. It is not a rulebook; it serves to distill our common understanding of a collaborative, shared environment and goals. We expect it to be followed in spirit as much as in the letter. When in doubt, try to abide by [Twilio SendGrid’s cultural values](https://sendgrid.com/blog/employee-engagement-the-4h-way) defined by our “4H’s”: Happy, Hungry, Humble and Honest.
21-
22-
### Enforcement
23-
Most members of the Twilio SendGrid community always comply with this Code, not because of the existence of this Code, but because they have long experience participating in open source communities where the conduct described above is normal and expected. However, failure to observe this Code may be grounds for suspension, reporting the user for abuse or changing permissions for outside contributors.
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
2422

25-
## If you have concerns about someone’s conduct
26-
**Initiate Direct Contact** - It is always appropriate to email a community member (if contact information is available), mention that you think their behavior was out of line, and (if necessary) point them to this Code.
23+
Examples of unacceptable behavior by participants include:
2724

28-
**Discuss Publicly** - Discussing publicly is always acceptable. Note, though, that approaching the person directly may be better, as it tends to make them less defensive, and it respects the time of other community members, so you probably want to try direct contact first.
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
2933

30-
**Contact the Moderators** - You can reach the Twilio SendGrid moderators by emailing [email protected].
31-
32-
## Attribution
34+
## Our Responsibilities
3335

34-
Twilio SendGrid thanks the following, on which it draws for content and inspiration:
35-
36-
* [Python Community Code of Conduct](https://www.python.org/psf/codeofconduct)
37-
* [Open Source Initiative General Code of Conduct](https://opensource.org/codeofconduct)
38-
* [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html)
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Before you decide to create a new issue, please try the following:
5555

5656
### Please use our Bug Report Template
5757

58-
In order to make the process easier, we've included a [sample bug report template]((https://github.com/sendgrid/sendgrid-python/.github/ISSUE_TEMPLATE)) (borrowed from [Ghost](https://github.com/TryGhost/Ghost/)). The template uses [GitHub flavored markdown](https://help.github.com/articles/github-flavored-markdown/) for formatting.
58+
In order to make the process easier, we've included a [sample bug report template]((https://github.com/sendgrid/sendgrid-python/ISSUE_TEMPLATE.md)) (borrowed from [Ghost](https://github.com/TryGhost/Ghost/)). The template uses [GitHub flavored markdown](https://help.github.com/articles/github-flavored-markdown/) for formatting.
5959

6060
<a name="improvements-to-the-codebase"></a>
6161
## Improvements to the Codebase

ISSUE_TEMPLATE.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!--
2+
If this is a feature request, make sure you search Issues for an existing request before creating a new one!
3+
-->
4+
5+
### Issue Summary
6+
A summary of the issue and the environment in which it occurs. If suitable, include the steps required to reproduce the bug. Please feel free to include screenshots, screencasts, or code examples.
7+
8+
### Steps to Reproduce
9+
1. This is the first step
10+
2. This is the second step
11+
3. Further steps, etc.
12+
13+
### Code Snippet
14+
```python
15+
# paste code here
16+
```
17+
18+
### Exception/Log
19+
```
20+
# paste exception/log here
21+
```
22+
23+
### Technical details:
24+
* sendgrid-python version:
25+
* python version:
26+

LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (C) 2020, Twilio SendGrid, Inc. <[email protected]>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
this software and associated documentation files (the "Software"), to deal in
7+
the Software without restriction, including without limitation the rights to
8+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9+
of the Software, and to permit persons to whom the Software is furnished to do
10+
so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

LICENSE.txt

-17
This file was deleted.

MANIFEST.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
include README.rst
2-
include LICENSE.txt
2+
include LICENSE.md
33
include app.json
44
include Procfile
55
include requirements.txt

PULL_REQUEST_TEMPLATE.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!--
2+
We appreciate the effort for this pull request but before that please make sure you read the contribution guidelines, then fill out the blanks below.
3+
4+
Please format the PR title appropriately based on the type of change:
5+
<type>[!]: <description>
6+
Where <type> is one of: docs, chore, feat, fix, test.
7+
Add a '!' after the type for breaking changes (e.g. feat!: new breaking feature).
8+
9+
**All third-party contributors acknowledge that any contributions they provide will be made under the same open-source license that the open-source project is provided under.**
10+
11+
Please enter each Issue number you are resolving in your PR after one of the following words [Fixes, Closes, Resolves]. This will auto-link these issues and close them when this PR is merged!
12+
e.g.
13+
Fixes #1
14+
Closes #2
15+
-->
16+
17+
# Fixes #
18+
19+
A short description of what this PR does.
20+
21+
### Checklist
22+
- [ ] I acknowledge that all my contributions will be made under the project's license
23+
- [ ] I have made a material change to the repo (functionality, testing, spelling, grammar)
24+
- [ ] I have read the [Contribution Guidelines](CONTRIBUTING.md) and my PR follows them
25+
- [ ] I have titled the PR appropriately
26+
- [ ] I have updated my branch with the master branch
27+
- [ ] I have added tests that prove my fix is effective or that my feature works
28+
- [ ] I have added necessary documentation about the functionality in the appropriate .md file
29+
- [ ] I have added inline documentation to the code I modified
30+
31+
If you have questions, please file a [support ticket](https://twilio.com/help/contact), or create a GitHub Issue in this repository.

README.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ License
303303
.. _Sign the CLA to Create a Pull Request: https://cla.sendgrid.com/sendgrid/sendgrid-python
304304
.. _troubleshooting guide: https://github.com/sendgrid/sendgrid-python/blob/master/TROUBLESHOOTING.md
305305
.. _Developer Experience Team: mailto:[email protected]
306-
.. _The MIT License (MIT): https://github.com/sendgrid/sendgrid-python/blob/master/LICENSE.txt
306+
.. _The MIT License (MIT): https://github.com/sendgrid/sendgrid-python/blob/master/LICENSE.md
307307

308308
.. |Travis Badge| image:: https://travis-ci.org/sendgrid/sendgrid-python.svg?branch=master
309309
:target: https://travis-ci.org/sendgrid/sendgrid-python
@@ -318,7 +318,7 @@ License
318318
.. |Email Notifications Badge| image:: https://dx.sendgrid.com/badge/python
319319
:target: https://dx.sendgrid.com/newsletter/python
320320
.. |MIT licensed| image:: https://img.shields.io/badge/license-MIT-blue.svg
321-
:target: ./LICENSE.txt
321+
:target: ./LICENSE.md
322322
.. |Twitter Follow| image:: https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow
323323
:target: https://twitter.com/sendgrid
324324
.. |GitHub contributors| image:: https://img.shields.io/github/contributors/sendgrid/sendgrid-python.svg

test/test_project.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,17 @@ def test_code_of_conduct(self):
4040
def test_contributing(self):
4141
self.assertTrue(os.path.isfile('./CONTRIBUTING.md'))
4242

43-
# ./.github/ISSUE_TEMPLATE
43+
# ./ISSUE_TEMPLATE.md
4444
def test_issue_template(self):
45-
self.assertTrue(os.path.isfile('./.github/ISSUE_TEMPLATE'))
45+
self.assertTrue(os.path.isfile('./ISSUE_TEMPLATE.md'))
4646

4747
# ./LICENSE.md
4848
def test_license(self):
49-
self.assertTrue(os.path.isfile('./LICENSE.txt'))
49+
self.assertTrue(os.path.isfile('./LICENSE.md'))
5050

51-
# ./.github/PULL_REQUEST_TEMPLATE
51+
# ./PULL_REQUEST_TEMPLATE.md
5252
def test_pr_template(self):
53-
self.assertTrue(os.path.isfile('./.github/PULL_REQUEST_TEMPLATE'))
53+
self.assertTrue(os.path.isfile('./PULL_REQUEST_TEMPLATE.md'))
5454

5555
# ./README.rst
5656
def test_readme(self):

test/test_sendgrid.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -2304,15 +2304,15 @@ def test_whitelabel_links__link_id__subuser_post(self):
23042304
self.assertEqual(response.status_code, 200)
23052305

23062306
def test_license_year(self):
2307-
LICENSE_FILE = 'LICENSE.txt'
2307+
LICENSE_FILE = 'LICENSE.md'
23082308
copyright_line=''
23092309
with open(LICENSE_FILE, 'r') as f:
23102310
for line in f:
23112311
if line.startswith('Copyright'):
23122312
copyright_line = line.strip()
23132313
break
23142314
self.assertEqual(
2315-
'Copyright (c) 2012-%s Twilio SendGrid, Inc.' % datetime.datetime.now().year,
2315+
'Copyright (C) %s, Twilio SendGrid, Inc. <[email protected]>' % datetime.datetime.now().year,
23162316
copyright_line)
23172317

23182318
# @classmethod

0 commit comments

Comments
 (0)