Skip to content

Commit 115a5e2

Browse files
author
childish-sambino
authored
docs: baseline all the templated markdown docs (#113)
1 parent 0359206 commit 115a5e2

9 files changed

+128
-80
lines changed

.github/ISSUE_TEMPLATE

-17
This file was deleted.

.github/PULL_REQUEST_TEMPLATE

-24
This file was deleted.

CODE_OF_CONDUCT.md

+57-25
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,73 @@
1-
# SendGrid Community Code of Conduct
1+
# Contributor Covenant Code of Conduct
22

3-
The 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.
3+
## Our Pledge
44

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.
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.
711

8-
### Be Considerate
9-
Members of the community are considerate of their peers, which include other contributors and users of 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.
12+
## Our Standards
1013

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 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 to 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.
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
1316

14-
## Additional Guidance
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
1522

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.
23+
Examples of unacceptable behavior by participants include:
1824

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 [SendGrid’s cultural values](https://sendgrid.com/blog/employee-engagement-the-4h-way) defined by our “4H’s”: Happy, Hungry, Humble and Honest.
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
2133

22-
### Enforcement
23-
Most members of the 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.
34+
## Our Responsibilities
2435

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.
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.
2739

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.
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.
2945

30-
**Contact the Moderators** - You can reach the SendGrid moderators by emailing [email protected].
46+
## Scope
3147

32-
## Submission to SendGrid Repositories
33-
Finally, just a reminder, changes to the SendGrid repositories will only be accepted upon completion of the [SendGrid Contributor Agreement](https://cla.sendgrid.com).
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.
3467

3568
## Attribution
3669

37-
SendGrid thanks the following, on which it draws for content and inspiration:
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
3872

39-
* [Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/)
40-
* [Open Source Initiative General Code of Conduct](https://opensource.org/codeofconduct)
41-
* [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html)
73+
[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

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

5252
### Please use our Bug Report Template
5353

54-
In order to make the process easier, we've included a [sample bug report template](https://github.com/sendgrid/ruby-http-client/.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.
54+
In order to make the process easier, we've included a [sample bug report template](https://github.com/sendgrid/ruby-http-client/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.
5555

5656
<a name="improvements-to-the-codebase"></a>
5757
## 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+
```ruby
15+
# paste code here
16+
```
17+
18+
### Exception/Log
19+
```
20+
# paste exception/log here
21+
```
22+
23+
### Technical details:
24+
* ruby-http-client version:
25+
* ruby version:
26+

LICENSE.txt LICENSE.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
The MIT License (MIT)
1+
MIT License
22

3-
Copyright (c) 2016-2020 Twilio SendGrid, Inc.
3+
Copyright (C) 2020, Twilio SendGrid, Inc. <[email protected]>
44

5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
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:
1111

1212
The above copyright notice and this permission notice shall be included in all
1313
copies or substantial portions of the Software.

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.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![BuildStatus](https://travis-ci.org/sendgrid/ruby-http-client.svg?branch=master)](https://travis-ci.org/sendgrid/ruby-http-client)
44
[![Email Notifications Badge](https://dx.sendgrid.com/badge/ruby)](https://dx.sendgrid.com/newsletter/ruby)
55
[![Gem Version](https://badge.fury.io/rb/sendgrid-ruby.svg)](https://badge.fury.io/rb/sendgrid-ruby)
6-
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.txt)
6+
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md)
77
[![Twitter Follow](https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow)](https://twitter.com/sendgrid)
88
[![GitHub contributors](https://img.shields.io/github/contributors/sendgrid/ruby-http-client.svg)](https://github.com/sendgrid/ruby-http-client/graphs/contributors)
99

@@ -112,4 +112,4 @@ ruby-http-client is guided and supported by the SendGrid [Developer Experience T
112112
ruby-http-client is maintained and funded by SendGrid, Inc. The names and logos for ruby-http-client are trademarks of SendGrid, Inc.
113113

114114
# License
115-
[The MIT License (MIT)](LICENSE.txt)
115+
[The MIT License (MIT)](LICENSE.md)

test/test_ruby_http_client.rb

+3-3
Original file line numberDiff line numberDiff line change
@@ -254,15 +254,15 @@ def test_contributing_exists
254254
end
255255

256256
def test_issue_template_exists
257-
assert(File.file?('./.github/ISSUE_TEMPLATE'))
257+
assert(File.file?('./ISSUE_TEMPLATE.md'))
258258
end
259259

260260
def test_license_exists
261261
assert(File.file?('./LICENSE.md') || File.file?('./LICENSE.txt'))
262262
end
263263

264264
def test_pull_request_template_exists
265-
assert(File.file?('./.github/PULL_REQUEST_TEMPLATE'))
265+
assert(File.file?('./PULL_REQUEST_TEMPLATE.md'))
266266
end
267267

268268
def test_readme_exists
@@ -278,7 +278,7 @@ def test_use_cases_exists
278278
end
279279

280280
def test_license_date_is_updated
281-
license_end_year = IO.read('LICENSE.txt').match(/Copyright \(c\) 2016-(\d{4}) Twilio SendGrid/)[1].to_i
281+
license_end_year = IO.read('LICENSE.md').match(/Copyright \(C\) (\d{4}), Twilio SendGrid/)[1].to_i
282282
current_year = Time.new.year
283283
assert_equal(current_year, license_end_year)
284284
end

0 commit comments

Comments
 (0)