Skip to content

Commit 738f006

Browse files
authored
Merge pull request #8 from Tell-SG/code-of-conduct
adding code of conduct and contribution guide
2 parents e7d3509 + f2ee8da commit 738f006

3 files changed

Lines changed: 113 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ krampus CHANGELOG
33

44
This file shows a change history for the krampus project
55

6+
0.3.6
7+
------
8+
- [Tell] add a code of conduct blurb and a CLA comment
9+
610
0.3.5
711
------
812
- [Chase] allow s3 kinder to accept multiple permissions to be removed from s3 object; fix dist script

CODE_OF_CONDUCT.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# SendGrid Community Code of Conduct
2+
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.
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.
7+
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.
10+
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.
13+
14+
## Additional Guidance
15+
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.
18+
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.
21+
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.
24+
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.
27+
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.
29+
30+
**Contact the Moderators** - You can reach the SendGrid moderators by emailing dx@sendgrid.com.
31+
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).
34+
35+
## Attribution
36+
37+
SendGrid thanks the following, on which it draws for content and inspiration:
38+
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)

CONTRIBUTING.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
Hello! Thank you for choosing to contribute to one of the SendGrid open source projects. There are many ways you can contribute and help is always welcome. We simply ask that you follow the following contribution policies.
2+
3+
- [CLAs and CCLAs](#cla)
4+
- [Creating a Pull Request](#creating-a-pull-request)
5+
6+
<a name="cla"></a>
7+
## CLAs and CCLAs
8+
9+
Before you get started, SendGrid requires that a SendGrid Contributor License Agreement (CLA) be filled out by every contributor to a SendGrid open source project.
10+
11+
Our goal with the CLA is to clarify the rights of our contributors and reduce other risks arising from inappropriate contributions. The CLA also clarifies the rights SendGrid holds in each contribution and helps to avoid misunderstandings over what rights each contributor is required to grant to SendGrid when making a contribution. In this way the CLA encourages broad participation by our open source community and helps us build strong open source projects, free from any individual contributor withholding or revoking rights to any contribution.
12+
13+
SendGrid does not merge a pull request made against a SendGrid open source project until that pull request is associated with a signed CLA. Copies of the CLA are available [here](https://gist.github.com/SendGridDX/98b42c0a5d500058357b80278fde3be8#file-sendgrid_cla).
14+
15+
When you create a Pull Request, after a few seconds, a comment will appear with a link to the CLA. Click the link and fill out the brief form and then click the "I agree" button and you are all set. You will not be asked to re-sign the CLA unless we make a change.
16+
17+
18+
<a name="creating-a-pull-request"></a>
19+
## Creating a Pull Request
20+
21+
1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork,
22+
and configure the remotes:
23+
24+
```bash
25+
# Clone your fork of the repo into the current directory
26+
git clone https://github.com/sendgrid/krampus
27+
# Navigate to the newly cloned directory
28+
cd krampus
29+
# Assign the original repo to a remote called "upstream"
30+
git remote add upstream https://github.com/sendgrid/krampus
31+
```
32+
33+
2. If you cloned a while ago, get the latest changes from upstream:
34+
35+
```bash
36+
git checkout <dev-branch>
37+
git pull upstream <dev-branch>
38+
```
39+
40+
3. Create a new topic branch (off the main project development branch) to
41+
contain your feature, change, or fix:
42+
43+
```bash
44+
git checkout -b <topic-branch-name>
45+
```
46+
47+
4. Commit your changes in logical chunks. Please adhere to these [git commit
48+
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
49+
or your code is unlikely be merged into the main project. Use Git's
50+
[interactive rebase](https://help.github.com/articles/interactive-rebase)
51+
feature to tidy up your commits before making them public.
52+
53+
5. Locally merge (or rebase) the upstream development branch into your topic branch:
54+
55+
```bash
56+
git pull [--rebase] upstream master
57+
```
58+
59+
6. Push your topic branch up to your fork:
60+
61+
```bash
62+
git push origin <topic-branch-name>
63+
```
64+
65+
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
66+
with a clear title and description against the `master` branch. All tests must be passing before we will review the PR.
67+
68+
If you have any additional questions, please feel free to [email](mailto:security@sendgrid.com) us or create an issue in this repo.

0 commit comments

Comments
 (0)