From 1db091d29dbc56b9ae809cdee70bd948737918f7 Mon Sep 17 00:00:00 2001 From: Dave Rolsky Date: Thu, 19 Jun 2025 14:25:23 -0500 Subject: [PATCH] Add community health docs --- .github/FUNDING.yml | 1 + CONTRIBUTING.md | 20 ++++++++++++++++++++ GOVERNANCE.md | 12 ++++++++++++ SECURITY.md | 9 +++++++++ SUPPORT.md | 7 +++++++ 5 files changed, 49 insertions(+) create mode 100644 .github/FUNDING.yml create mode 100644 CONTRIBUTING.md create mode 100644 GOVERNANCE.md create mode 100644 SECURITY.md create mode 100644 SUPPORT.md diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..99444c4 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +github: autarch diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3d3b886 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +# Contributing + +Thank you for your interest in contributing to this project. This file contains instructions that +will help you work with the source code. + +Please note that if you have any questions or difficulties, you can reach the maintainer through +GitHub Issues. Filing an issue is the preferred method for reporting bugs or issues with the +development tool configuration for this project. + +If you'd like to suggest a small change, you can do that by directly creating a +[Pull Request](https://docs.github.com/en/pull-requests). For larger changes, you are encouraged to +file an issue first, so we can discuss the change before you spend too much time implementing it. + +Please note that the maintainer, Dave Rolsky (@autarch), mostly works on his FOSS projects in his +free time, which means on weekends and days off. However, he does not work on these things _every_ +weekend, so it may be a little while before you get a response to your issue or PR. + +If it's been more than 3 weeks since you submitted an issue or PR, feel free to comment on the +submission to nudge the maintainer, who is probably getting sucked into some new video game and +spending all his time there. diff --git a/GOVERNANCE.md b/GOVERNANCE.md new file mode 100644 index 0000000..1dc98ac --- /dev/null +++ b/GOVERNANCE.md @@ -0,0 +1,12 @@ +# Project Governance + +This repository works through the BDFL – Benevolent Dictator For Life - model. That means that a +single maintainer, Dave Rolsky (@autarch), holds all of the admin keys and write access for this +repository. Other users are encouraged to open issues, submit Pull Requests, and to ask for +recognition as maintainers, but all decisions ultimately lie with the core maintainer. + +This maintainer is open to others joining on the admin team for this repository, but prospective +admins will need a track record of contributions in the form of PRs and issue responses first. + +Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more details on how to file issues and +PRs for this project. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..a399ec5 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,9 @@ +# Reporting Security Issues + +To report a security issue, please use the GitHub Security Advisory "Report a Vulnerability" tab. + +The project maintainer(s) will send a response indicating the next steps in handling your report. +After the initial reply to your report, the maintainer(s) will keep you informed of the progress +towards a fix and full announcement, and may ask for additional information or guidance. + +Report security bugs in third-party packages to the person or team maintaining the package. diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 0000000..3d98285 --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,7 @@ +# How to file issues and get help + +This project uses GitHub Issues to track bugs and feature requests. Please search the existing +issues before filing new issues to avoid duplicates. For new issues, file your bug or feature +request as a new Issue. + +For help and questions about using this project, you can use GitHub Issues as well.