Skip to content

Commit dbe8ad2

Browse files
Schow94bitfield
andauthored
Create Code of Conduct (#135)
* Create Code of Conduct Co-authored-by: John Arundel <[email protected]>
1 parent 31e02cb commit dbe8ad2

File tree

2 files changed

+53
-9
lines changed

2 files changed

+53
-9
lines changed

CODE_OF_CONDUCT.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# CONTRIBUTOR CODE OF CONDUCT
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
* Using welcoming and inclusive language
11+
* Being respectful of differing viewpoints and experiences
12+
* Gracefully accepting constructive criticism
13+
* Focusing on what is best for the community
14+
* Showing empathy towards other community members
15+
16+
Examples of unacceptable behavior by participants include:
17+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
18+
* Trolling, insulting/derogatory comments, and personal or political attacks
19+
* Public or private harassment
20+
* Publishing others’ private information, such as a physical or electronic address, without explicit permission
21+
* Other conduct which could reasonably be considered inappropriate in a professional setting
22+
23+
## Our Responsibilities
24+
25+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
26+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
27+
28+
## Scope
29+
30+
This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
31+
32+
## Enforcement
33+
34+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
35+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.
36+
37+
## Attribution
38+
39+
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
40+
For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq

CONTRIBUTING.md

+13-9
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Test data should go in the `testdata` directory. If you create a file of data fo
3838

3939
### Use the standard library
4040

41-
All `script` tests use the standard Go `testing` library; they don't use `testify` or `gock` or any of the other tempting and shiny test libraries. There's nothing wrong with those libraries, but it's good to keep things consistent, and not import any libraries we don't absolutely need.
41+
All `script` tests use the standard Go `testing` library; they don't use `testify` or `gock` or any of the other tempting and shiny test libraries. There's nothing wrong with those libraries, but it's good to keep things consistent, and not import any libraries we don't absolutely need.
4242

4343
You'll get the feel of things by reading the existing tests, and maybe copying and adapting them for your own feature.
4444

@@ -123,13 +123,13 @@ Any change to the `script` API should also be accompanied by an update to the RE
123123
124124
Here's a handy checklist for making sure your PR will be accepted as quickly as possible.
125125
126-
- [ ] Have you opened an issue to discuss the feature and agree its general design?
127-
- [ ] Do you have a use case and, ideally, an example program using the feature?
128-
- [ ] Do you have tests covering 90%+ of the feature code (and, of course passing)
129-
- [ ] Have you added your method to the `doMethodsOnPipe` stress tests?
130-
- [ ] Have you written complete and accurate doc comments?
131-
- [ ] Have you updated the README and its table of contents?
132-
- [ ] You rock. Thanks a lot.
126+
- [ ] Have you opened an issue to discuss the feature and agree its general design?
127+
- [ ] Do you have a use case and, ideally, an example program using the feature?
128+
- [ ] Do you have tests covering 90%+ of the feature code (and, of course passing)
129+
- [ ] Have you added your method to the `doMethodsOnPipe` stress tests?
130+
- [ ] Have you written complete and accurate doc comments?
131+
- [ ] Have you updated the README and its table of contents?
132+
- [ ] You rock. Thanks a lot.
133133
134134
# After submitting your PR
135135
@@ -165,4 +165,8 @@ In fact, doing a _proper_ and serious code review is a time-consuming business.
165165
166166
Open source maintainers are just regular folk with jobs, kids, and zero free time or energy. They may not be able to drop everything and put in several hours on your PR. The task may have to wait a week or two until they can get sufficient time and peace and quiet to work on it. Don't pester them. It's fine to add a comment on the PR if you haven't heard anything for a while, asking if the reviewer's been able to look at it and whether there's anything you can do to help speed things up. Comments like 'Y U NO MERGE' are unlikely to elicit a positive response.
167167
168-
Thanks again for helping out!
168+
Thanks again for helping out!
169+
170+
## Code of Conduct
171+
172+
As a contributor you can help keep the `script` community inclusive and open to everyone. Please read and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md).

0 commit comments

Comments
 (0)