Skip to content

Commit 782d41b

Browse files
committed
Add community health docs
1 parent 5b98c52 commit 782d41b

File tree

6 files changed

+114
-0
lines changed

6 files changed

+114
-0
lines changed

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: autarch

CODE_OF_CONDUCT.md

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

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to this project. This file contains instructions that
4+
will help you work with the source code.
5+
6+
Please note that if you have any questions or difficulties, you can reach the maintainer through
7+
GitHub Issues. Filing an issue is the preferred method for reporting bugs or issues with the
8+
development tool configuration for this project.
9+
10+
If you'd like to suggest a small change, you can do that by directly creating a
11+
[Pull Request](https://docs.github.com/en/pull-requests). For larger changes, you are encouraged to
12+
file an issue first, so we can discuss the change before you spend too much time implementing it.
13+
14+
Please note that the maintainer, Dave Rolsky (@autarch), mostly works on his FOSS projects in his
15+
free time, which means on weekends and days off. However, he does not work on these things _every_
16+
weekend, so it may be a little while before you get a response to your issue or PR.
17+
18+
If it's been more than 3 weeks since you submitted an issue or PR, feel free to comment on the
19+
submission to nudge the maintainer, who is probably getting sucked into some new video game and
20+
spending all his time there.

GOVERNANCE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Project Governance
2+
3+
This repository works through the BDFL – Benevolent Dictator For Life - model. That means that a
4+
single maintainer, Dave Rolsky (@autarch), holds all of the admin keys and write access for this
5+
repository. Other users are encouraged to open issues, submit Pull Requests, and to ask for
6+
recognition as maintainers, but all decisions ultimately lie with the core maintainer.
7+
8+
This maintainer is open to others joining on the admin team for this repository, but prospective
9+
admins will need a track record of contributions in the form of PRs and issue responses first.
10+
11+
Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more details on how to file issues and
12+
PRs for this project.

SECURITY.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Reporting Security Issues
2+
3+
To report a security issue, please use the GitHub Security Advisory "Report a Vulnerability" tab.
4+
5+
The project maintainer(s) will send a response indicating the next steps in handling your report.
6+
After the initial reply to your report, the maintainer(s) will keep you informed of the progress
7+
towards a fix and full announcement, and may ask for additional information or guidance.
8+
9+
Report security bugs in third-party packages to the person or team maintaining the package.

SUPPORT.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# How to file issues and get help
2+
3+
This project uses GitHub Issues to track bugs and feature requests. Please search the existing
4+
issues before filing new issues to avoid duplicates. For new issues, file your bug or feature
5+
request as a new Issue.
6+
7+
For help and questions about using this project, you can use GitHub Issues as well.

0 commit comments

Comments
 (0)