[WIP] Add missing GitHub community health files - #97
Conversation
- CODE_OF_CONDUCT.md (Contributor Covenant v2.1) - SECURITY.md (vulnerability reporting guidance) - SUPPORT.md (how to get help) - .github/ISSUE_TEMPLATE/bug_report.yml - .github/ISSUE_TEMPLATE/feature_request.yml - .github/ISSUE_TEMPLATE/config.yml - .github/PULL_REQUEST_TEMPLATE.md Agent-Logs-Url: https://github.com/tim-dickey/trivia-app/sessions/583195ce-9cfd-4d4c-9cd2-146643288746 Co-authored-by: tim-dickey <80638631+tim-dickey@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds missing GitHub community health files to improve contribution workflow, support channels, and security reporting guidance for the repository.
Changes:
- Adds community policies:
CODE_OF_CONDUCT.md,SECURITY.md, andSUPPORT.md - Adds GitHub Issue Forms templates (bug report / feature request) plus issue template config
- Adds a repository pull request template
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| CODE_OF_CONDUCT.md | Introduces a Code of Conduct (Contributor Covenant-based) for community behavior expectations. |
| SECURITY.md | Defines supported versions and vulnerability reporting process. |
| SUPPORT.md | Documents where users should go for help (issues/discussions/docs) and expected response times. |
| .github/PULL_REQUEST_TEMPLATE.md | Adds a PR submission checklist and structure for contributors. |
| .github/ISSUE_TEMPLATE/bug_report.yml | Adds a structured bug report issue form. |
| .github/ISSUE_TEMPLATE/feature_request.yml | Adds a structured feature request issue form. |
| .github/ISSUE_TEMPLATE/config.yml | Configures issue creation UX (blank issues off, contact links). |
| ### GitHub Issues | ||
| For bugs, feature requests, and technical issues, please open a [GitHub Issue](https://github.com/your-org/trivia-app/issues). | ||
|
|
There was a problem hiding this comment.
https://github.com/your-org/trivia-app/... is a placeholder and will send users to a non-existent repo. Please update these links to the actual repository (e.g. tim-dickey/trivia-app) or use relative links like /issues and /discussions so they remain correct if the repo is forked/renamed. Also remove the trailing whitespace at the end of this line.
| url: https://github.com/your-org/trivia-app/discussions | ||
| about: Ask questions and discuss ideas in our community discussions | ||
| - name: Security Vulnerability | ||
| url: https://github.com/your-org/trivia-app/security/advisories |
There was a problem hiding this comment.
These your-org/trivia-app URLs are placeholders. Please replace them with the actual repo URLs (or relative links), and consider pointing the security contact link directly to the private report form (.../security/advisories/new) rather than the advisories list.
| url: https://github.com/your-org/trivia-app/discussions | |
| about: Ask questions and discuss ideas in our community discussions | |
| - name: Security Vulnerability | |
| url: https://github.com/your-org/trivia-app/security/advisories | |
| url: /discussions | |
| about: Ask questions and discuss ideas in our community discussions | |
| - name: Security Vulnerability | |
| url: /security/advisories/new |
| | Version | Supported | End of Life | | ||
| | ------- | ------------------ | ----------- | | ||
| | 1.x | :white_check_mark: | TBD | | ||
| | < 1.0 | :x: | Unsupported | | ||
|
|
There was a problem hiding this comment.
The supported versions table appears inconsistent with this repo’s current versioning (e.g., CHANGELOG.md includes 0.1.0). Marking all < 1.0 as unsupported would discourage vulnerability reports for current releases. Please update the table to reflect the actual supported release lines (likely 0.x until 1.0) and clarify EOL policy.
| | Version | Supported | End of Life | | |
| | ------- | ------------------ | ----------- | | |
| | 1.x | :white_check_mark: | TBD | | |
| | < 1.0 | :x: | Unsupported | | |
| | Version | Supported | End of Life | | |
| | ------- | ------------------ | ------------------------------ | | |
| | 0.x | :white_check_mark: | Supported until 1.0.0 is released | | |
| | < 0.1.0 | :x: | Unsupported | | |
| Before `1.0.0`, we support security fixes for the current `0.x` release line. Older pre-release versions may not receive patches once superseded by a newer `0.x` release. After `1.0.0`, this table and the project's end-of-life policy will be updated to reflect the supported stable release lines. |
| **Please do not open a public GitHub issue for security vulnerabilities.** Instead, please use one of the following methods: | ||
|
|
||
| 1. **GitHub Security Advisory**: Use GitHub's built-in "Report a vulnerability" button on the Security tab of this repository. This creates a private security advisory that only the maintainers can see. | ||
|
|
||
| 2. **Email**: Send a detailed report to `security@example.com` with: | ||
| - Description of the vulnerability | ||
| - Steps to reproduce | ||
| - Potential impact | ||
| - Suggested fix (if you have one) |
There was a problem hiding this comment.
security@example.com is a placeholder address. Please either replace it with a real security contact for this project, or remove the email option and direct reporters exclusively to GitHub Security Advisories (or clearly label the email as a placeholder to be configured).
| ## Enforcement | ||
|
|
||
| Community members who do not follow the Code of Conduct in good faith may face temporary or permanent repercussions as determined by project maintainers. | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainers at conduct@example.com. All complaints will be reviewed and investigated. | ||
|
|
||
| ## Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. | ||
|
|
There was a problem hiding this comment.
This file says it’s Contributor Covenant v2.1, but it omits several standard v2.1 sections (e.g., Scope, Enforcement Guidelines, Reporting Guidelines, Enforcement Responsibilities). Please include the full v2.1 text (or explicitly state this is an abbreviated adaptation) to avoid mismatching the PR’s stated intent and common community expectations.
|
|
||
| Community members who do not follow the Code of Conduct in good faith may face temporary or permanent repercussions as determined by project maintainers. | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainers at conduct@example.com. All complaints will be reviewed and investigated. |
There was a problem hiding this comment.
conduct@example.com is a placeholder address. Please replace it with a real contact mechanism for Code of Conduct reports (e.g., a monitored email alias) or adjust the reporting instructions to use an existing channel the maintainers will actually receive (while keeping reports private).
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainers at conduct@example.com. All complaints will be reviewed and investigated. | |
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported through the project's private maintainer contact channel. Please do not report incidents in public issues, discussions, or pull requests. All complaints will be reviewed and investigated. |
|
@copilot apply changes based on the comments in this thread |
- CODE_OF_CONDUCT.md: expand to full Contributor Covenant v2.1 text (added Pledge, Enforcement Responsibilities, Scope, Enforcement Guidelines sections); replace conduct@example.com placeholder with private maintainer contact channel wording - SECURITY.md: fix supported-versions table to reflect 0.x release line with clarified EOL policy; remove security@example.com placeholder and direct reporters exclusively to GitHub Security Advisories - SUPPORT.md: replace placeholder your-org/trivia-app URLs with relative links (/issues, /discussions); remove trailing whitespace - .github/ISSUE_TEMPLATE/config.yml: replace placeholder URLs with relative links; point security link to /security/advisories/new Agent-Logs-Url: https://github.com/tim-dickey/trivia-app/sessions/f3f30fbc-8e07-42d9-93f0-3e83b67f3388 Co-authored-by: tim-dickey <80638631+tim-dickey@users.noreply.github.com>
CODE_OF_CONDUCT.md: expand to full Contributor Covenant v2.1 text; replaceconduct@example.comwith private-channel wordingSECURITY.md: fix supported-versions table to reflect0.x; remove placeholder emailSUPPORT.md: replace placeholder URLs with relative links; remove trailing whitespace.github/ISSUE_TEMPLATE/config.yml: replace placeholder URLs with relative links; point security link to/security/advisories/newOriginal prompt
Create a PR that adds missing GitHub community health files to
tim-dickey/trivia-app.Add a full standard set of community files only if missing, using consistent content across repos:
CODE_OF_CONDUCT.md(Contributor Covenant v2.1)SECURITY.md(how to report vulnerabilities; include supported versions guidance; provide placeholder contact instructions if no security email exists)SUPPORT.md(how to get help: issues/discussions; response time expectations).github/ISSUE_TEMPLATE/bug_report.yml.github/ISSUE_TEMPLATE/feature_request.yml.github/ISSUE_TEMPLATE/config.yml(disable blank issues if appropriate; include contact links).github/PULL_REQUEST_TEMPLATE.mdNotes / repo-specific findings:
README.md,LICENSE,CONTRIBUTING.mdin root..githubexists but does not include issue templates, security policy, code of conduct, or PR template.Acceptance criteria:
The following is the prior conversation context from the user's chat exploration (may be truncated):
User: Run a scan of my public repos. Show me which repos do not meet community guidelines.
Assistant: I can’t run that scan yet because the GitHub API tool available in this chat doesn’t currently support the endpoint needed to list your public repositories (e.g.
/users/{username}/repos), so I can’t reliably enumerate your repos to check them.If you paste either:
…I’ll check each one against GitHub’s commonly expected “community health” files and settings and report which repos are missing items.
What I will scan for (community guidelines / community profile)
For each repo, I’ll flag missing:
README(project description / usage)LICENSE(license clarity)CODE_OF_CONDUCT.mdCONTRIBUTING.mdSECURITY.md(security policy).github/ISSUE_TEMPLATE/*) and/or PR templateSUPPORT.mdQuick self-check (fastest path)
While you send the repo list, you can also see GitHub’s own per-repo indicator at:
https://github.com/<owner>/<repo>/communitySend me your repo URLs (or the output of
gh repo list tim-dickey --public --limit 200) and I’ll return a concise table of repos that don’t meet the checklist and exactly what each is missing.User: @tim-dickey/trivia-app
@tim-dickey/multi-modal-neural-network
@tim-dickey/Engineering-factory-ai
@tim-dickey/OpenClaw-agents
@tim-dickey/duplicate-finding-tool
@tim-dickey/voice-clone
@tim-dickey/Data-Cap-WP-plugin
@tim-dickey/trendresponse
These are the public repos
Assistant: Repos that do not meet common GitHub “community guidelines” expectations (based on presence of standard community health files in the repo root and
.github/) are:.github/there, see note)Repos that look OK / meet guidelines much better:
Findings (what’s missing)
tim-dickey/trivia-app
Has:
README.md,LICENSE,CONTRIBUTING.mdMissing / not found:
CODE_OF_CONDUCT.md,SECURITY.md, issue templates (.github/ISSUE_TEMPLATE/*), PR template (.github/PULL_REQUEST_TEMPLATE*)tim-dickey/multi-modal-neural-network
Has:
README.md,LICENSE,CONTRIBUTING.md, PR template directory exists (.github/PULL_REQUEST_TEMPLATE/)Missing / not found:
CODE_OF_CONDUCT.md,SECURITY.md, issue templates (.github/ISSUE_TEMPLATE/*)tim-dickey/Engineering-factory-ai
Has:
README.md,LICENSE,CODE_OF_CONDUCT.md,CONTRIBUTING.md,SECURITY.md,SUPPORT.md, issue templates (.github/ISSUE_TEMPLATE/), PR template (.github/pull_request_template.md)Looks community-ready.
tim-dickey/OpenClaw-agents
Has:
README.md,LICENSE,CODE_OF_CONDUCT.md,CONTRIBUTING.md,SECURITY.md(in.github/SECURITY.md), issue templates (.github/ISSUE_TEMPLATE/), PR template (.github/PULL_REQUEST_TEMPLATE.md)Looks community-ready.
tim-dickey/duplicate-finding-tool
Has:
README.md,LICENSEMissing / not found:
CONTRIBUTING.md,CODE_OF_CONDUCT.md,SECURITY.md, issue templates, PR templatetim-dickey/voice-clone
Has:
README.md,LICENSEMissing / not found:
CONTRIBUTING.md,CODE_OF_CONDUCT.md,SECURITY.md, issue templates, PR templatetim-dickey/Data-Cap-WP-plugin
Has:
README.mdMissing / not found:
LICENSE, `...This pull request was created from Copilot chat.