Skip to content

✨ Add community health files and governance templates#151

Merged
stoe merged 4 commits into
mainfrom
stoe/community-health-files
Apr 17, 2026
Merged

✨ Add community health files and governance templates#151
stoe merged 4 commits into
mainfrom
stoe/community-health-files

Conversation

@stoe
Copy link
Copy Markdown
Owner

@stoe stoe commented Apr 17, 2026

Description

This pull request establishes a comprehensive set of GitHub community health files and governance documentation to improve project maintainability, contribution experience, and security posture. These templates provide structure for contributors and maintainers to follow consistent processes.

Type of Change

  • New feature (non-breaking change which adds functionality)
  • Documentation update

Changes Made

  • Added code_of_conduct.md to establish community standards and expected behavior
  • Created issue templates: bug_report.md and feature_request.md with issue config
  • Updated pull_request_template.md with comprehensive checks and metadata guidance
  • Enhanced contributing.md with clearer contribution guidelines and standards
  • Improved security.md with security policy and reporting procedures

Testing

No functional code changes; community files verified for formatting and completeness.

Checklist

  • My commits are signed with a verified signature (required)
  • I have updated documentation for new community files
  • All community files follow GitHub community standards

Additional Context

These templates support best practices for open source governance and help streamline contributions.

Copilot AI review requested due to automatic review settings April 17, 2026 09:33
@stoe stoe self-assigned this Apr 17, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds/updates GitHub community health and governance documentation under .github/ to standardize contribution, issue reporting, PR submission, and security reporting processes for the repository.

Changes:

  • Expanded .github/security.md with clearer vulnerability reporting instructions and contributor security requirements.
  • Added a PR template and GitHub issue templates/config to structure incoming contributions.
  • Updated contributing guidance and introduced a Code of Conduct document.
Show a summary per file
File Description
.github/security.md Expands security policy and adds contributor/dependency security guidance.
.github/pull_request_template.md Adds a PR template with sections and contributor checklist.
.github/issue_template/bug_report.md Adds a bug report issue template.
.github/issue_template/feature_request.md Adds a feature request issue template.
.github/issue_template/config.yml Adds issue template configuration (disables blank issues, adds contact link).
.github/contributing.md Updates contribution workflow and links to templates/CoC; adds signing/labels guidance.
.github/code_of_conduct.md Adds a Contributor Covenant-based Code of Conduct.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comments suppressed due to low confidence (2)

.github/contributing.md:31

  • The links to the issue templates use hyphenated filenames (bug-report.md, feature-request.md), but the actual template files are bug_report.md and feature_request.md. Update these links to match the real paths so contributors don’t hit 404s.
Before creating bug reports, please check the existing issues to avoid duplicates. Use the [Bug Report template](./issue_template/bug-report.md) when creating a bug report. When you create a bug report, include as many details as possible:

- A clear and descriptive title
- Steps to reproduce the behavior
- Expected behavior versus actual behavior
- Screenshots or terminal output (if applicable)
- Environment details (OS, Node.js version, etc.)
- Command line arguments you used with the tool

See [About issue and pull request templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates) for more information.

### Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. Use the [Feature Request template](./issue_template/feature-request.md) when creating an enhancement suggestion:

.github/contributing.md:88

  • There appears to be a stray sentence fragment starting with a leading comma on this line, and the README update guidance is duplicated across two consecutive lines. Please remove the fragment and keep a single, clear instruction so the Pull Request section reads cleanly.
, please use the [Pull Request template](./pull_request_template.md). Pull requests that affect functionality must include updates to the relevant documentation in the README.md file
When submitting pull requests that affect functionality, please make sure to update the relevant documentation in the README.md file as well.
  • Files reviewed: 7/7 changed files
  • Comments generated: 3

Comment thread .github/pull_request_template.md Outdated
Comment thread .github/ISSUE_TEMPLATE/config.yml
Comment thread .github/contributing.md Outdated
stoe and others added 2 commits April 17, 2026 11:39
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Stefan Stölzle <stoe@github.com>
@stoe stoe added the feature-request 🚧 Want something new? label Apr 17, 2026
@stoe stoe merged commit 187e0f0 into main Apr 17, 2026
8 checks passed
@stoe stoe deleted the stoe/community-health-files branch April 17, 2026 09:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature-request 🚧 Want something new?

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants