Skip to content

Commit db04eb0

Browse files
chore: add CONTRIBUTING.md (siderolabs#337)
Signed-off-by: Andrew Rynhard <[email protected]>
1 parent 9240dec commit db04eb0

File tree

3 files changed

+117
-0
lines changed

3 files changed

+117
-0
lines changed

Diff for: CODE_OF_CONDUCT.md

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
## 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 at [INSERT EMAIL ADDRESS]. 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
77+

Diff for: CONTRIBUTING.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing
2+
3+
First of all, thank you!
4+
We value your time and interest in making Talos a successful open source project.
5+
6+
## What can I do to help?
7+
8+
There are a number of ways you can help!
9+
We are in need of both technical and non-technical contributions.
10+
Even just mentioning the project to a friend, collegue, or anyone else for that matter, would be a huge help.
11+
We need writers, bloggers, engineers, graphics designers — you name it, we need it.
12+
13+
## Guidelines
14+
15+
Let's talk about some of the guidelines we have when making a contribution to Talos.
16+
17+
### Git Commits
18+
19+
You probably noticed we use have a funny way of writing commit messages.
20+
Indeed we do, but its based on a specification called [Conventional Commits](https://www.conventionalcommits.org).
21+
Don't worry, it won't be _too_ much of hassle.
22+
We have a small tool that you can use to remind you of our policy.
23+
24+
```bash
25+
go get github.com/autonomy/conform
26+
cat <EOF | tee .git/hooks/commit-msg
27+
#!/bin/sh
28+
29+
conform enforce --commit-msg-file $1
30+
EOF
31+
```
32+
33+
### Pull Requests
34+
35+
To avoid multiples CI runs, please ensure that you are running a full build before submitting your PR.
36+

Diff for: README.md

+4
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,10 @@ k8s.io e42ec788edc1e3af71cb6fa151dd8cc1076906dbe09d7099697f36069e38b5a8 s
111111
k8s.io kubelet k8s.gcr.io/hyperkube:v1.13.2 2068 RUNNING
112112
```
113113

114+
## Contributing
115+
116+
See [CONTRIBUTING.md](CONTRIBUTING.md)
117+
114118
## Changelog
115119

116120
See [CHANGELOG.md](CHANGELOG.md)

0 commit comments

Comments
 (0)