Skip to content

Commit 079a924

Browse files
gabe-l-hartgabe-l-hart
committed
main: Add project framing (codeowners, code of conduct, contributing)
Signed-off-by: Gabe Goodhart <[email protected]>
1 parent 41fd458 commit 079a924

File tree

3 files changed

+227
-0
lines changed

3 files changed

+227
-0
lines changed

‎CODEOWNERS

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#####################################################
2+
#
3+
# List of approvers for scriptit repository
4+
#
5+
#####################################################
6+
#
7+
# Learn about CODEOWNERS file format:
8+
# https://help.github.com/en/articles/about-code-owners
9+
#
10+
11+
* @gabe-l-hart

‎CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Community Code of Conduct
2+
3+
## Our Pledge
4+
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.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
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
22+
23+
Examples of unacceptable behavior by participants include:
24+
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
33+
34+
## Our Responsibilities
35+
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](./CODEOWNERS). 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
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

‎CONTRIBUTING.md

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
# Script It Contributor Guide
2+
3+
Welcome to Script It! This document is the single source of truth for how to contribute to the code base. Feel free to browse the [open issues](https://github.com/IBM/scriptit/issues) and file new ones, all feedback welcome!
4+
5+
# Before you get started
6+
7+
## Sign the DCO
8+
9+
The sign-off is a simple line at the end of the explanation for a commit. All commits needs to be signed. Your signature certifies that you wrote the patch or otherwise have the right to contribute the material. The rules are pretty simple, if you can certify the below (from [developercertificate.org](https://developercertificate.org/)):
10+
11+
```
12+
Developer Certificate of Origin
13+
Version 1.1
14+
15+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
16+
1 Letterman Drive
17+
Suite D4700
18+
San Francisco, CA, 94129
19+
20+
Everyone is permitted to copy and distribute verbatim copies of this
21+
license document, but changing it is not allowed.
22+
23+
Developer's Certificate of Origin 1.1
24+
25+
By making a contribution to this project, I certify that:
26+
27+
(a) The contribution was created in whole or in part by me and I
28+
have the right to submit it under the open source license
29+
indicated in the file; or
30+
31+
(b) The contribution is based upon previous work that, to the best
32+
of my knowledge, is covered under an appropriate open source
33+
license and I have the right under that license to submit that
34+
work with modifications, whether created in whole or in part
35+
by me, under the same open source license (unless I am
36+
permitted to submit under a different license), as indicated
37+
in the file; or
38+
39+
(c) The contribution was provided directly to me by some other
40+
person who certified (a), (b) or (c) and I have not modified
41+
it.
42+
43+
(d) I understand and agree that this project and the contribution
44+
are public and that a record of the contribution (including all
45+
personal information I submit with it, including my sign-off) is
46+
maintained indefinitely and may be redistributed consistent with
47+
this project or the open source license(s) involved.
48+
```
49+
50+
Then you just add a line to every git commit message:
51+
52+
Signed-off-by: Joe Smith <[email protected]>
53+
54+
Use your real name (sorry, no pseudonyms or anonymous contributions.)
55+
56+
If you set your `user.name` and `user.email` git configs, you can sign your commit automatically
57+
with `git commit -s`.
58+
59+
Note: If your git config information is set properly then viewing the `git log` information for your
60+
commit will look something like this:
61+
62+
```
63+
Author: Joe Smith <[email protected]>
64+
Date: Thu Feb 2 11:41:15 2018 -0800
65+
66+
Update README
67+
68+
Signed-off-by: Joe Smith <[email protected]>
69+
```
70+
71+
Notice the `Author` and `Signed-off-by` lines match. If they don't your PR will be rejected by the
72+
automated DCO check.
73+
74+
## Code attribution
75+
76+
License information should be included in all source files where applicable. Either full or short version of the header should be used as described at [apache.org](http://www.apache.org/foundation/license-faq.html#Apply-My-Software). It is OK to exclude the year from the copyright notice. For the details on how to apply the copyright, see the next section.
77+
78+
## Copyright Notices
79+
80+
Script It used "Copyright The Script It Authors" notice form.
81+
82+
If you are contributing third-party code you will need to retain the original copyright notice.
83+
84+
Any contributed third-party code must originally be Apache 2.0-Licensed or must carry a permissive software license that is compatible when combining with Apache 2.0 License. At this moment, BSD and MIT are the only [OSI-approved licenses](https://opensource.org/licenses/alphabetical) known to be compatible.
85+
86+
If you make substantial changes to the third-party code, _prepend_ the contributed third party file with Script It's copyright notice.
87+
88+
If the contributed code is not third-party code and you are the author we strongly encourage to avoid including your name in the notice and use the generic "Copyright The Script It Authors" notice.
89+
90+
## Code of Conduct
91+
92+
Please make sure to read and observe our [Code of Conduct](./CODE_OF_CONDUCT.md).
93+
94+
# Your First Contribution
95+
96+
Would you like to help drive the community forward? We will help you understand the organization of the project and direct you to the best places to get started. You'll be able to pick up issues, write code to fix them, and get your work reviewed and merged.
97+
98+
## Find something to work on
99+
100+
Help is always welcome! For example, documentation (like the text you are reading now) can always use improvement. There's always code that can be clarified and variables or functions that can be renamed or commented. There's always a need for more test coverage. You get the idea: if you ever see something you think should be fixed, you should own it.
101+
102+
Those interested in contributing without writing code may help documenting, evangelizing or helping answer questions about Script It on various forums.
103+
104+
### File an Issue
105+
106+
Not ready to contribute code, but see something that needs work? While the community encourages everyone to contribute code, it is also appreciated when someone reports an issue (aka problem).
107+
108+
### Contributing
109+
110+
Script It is open source, but many of the people working on it do so as their day job. In order to avoid forcing people to be "at work" effectively 24/7, we want to establish some semi-formal protocols around development. Hopefully, these rules make things go more smoothly. If you find that this is not the case, please complain loudly.
111+
112+
As a potential contributor, your changes and ideas are welcome at any hour of the day or night, weekdays, weekends, and holidays. Please do not ever hesitate to ask a question or send a pull request.
113+
114+
## GitHub workflow
115+
116+
To check out code to work on, please refer to [the GitHub Workflow Guide](https://github.com/kubernetes/community/blob/master/contributors/guide/github-workflow.md) from Kubernetes. Script It uses the same workflow. One of the main highlights - all the work should happen on forks, to minimize the number of branches on a given repository.
117+
118+
## Open a Pull Request
119+
120+
Pull requests are often called simply "PR". Script It follows the standard [github pull request](https://help.github.com/articles/about-pull-requests/) process.
121+
122+
## Code Review
123+
124+
There are two aspects of code review: giving and receiving.
125+
126+
To make it easier for your PR to receive reviews, consider the reviewers will need you to:
127+
128+
- follow the project and repository coding conventions
129+
- write [good commit messages](https://chris.beams.io/posts/git-commit/)
130+
- break large changes into a logical series of smaller patches which individually make easily understandable changes, and in aggregate solve a broader issue
131+
132+
Reviewers, the people giving the review, are highly encouraged to revisit the [Code of Conduct](./CODE_OF_CONDUCT.md) and must go above and beyond to promote a collaborative, respectful community.
133+
134+
When reviewing PRs from others [The Gentle Art of Patch Review](http://sage.thesharps.us/2014/09/01/the-gentle-art-of-patch-review/) suggests an iterative series of focuses which is designed to lead new contributors to positive collaboration without inundating them initially with nuances:
135+
136+
- Is the idea behind the contribution sound?
137+
- Is the contribution architected correctly?
138+
- Is the contribution polished?
139+
140+
Note: if your pull request isn't getting enough attention, you can explicitly mention approvers or maintainers of this repository.

0 commit comments

Comments
 (0)