Skip to content

docs: add CODE_OF_CONDUCT, SECURITY policy, PR/issue templates - #8

Open
rrahimi-uci wants to merge 3 commits into
mainfrom
chore/community-health-files
Open

docs: add CODE_OF_CONDUCT, SECURITY policy, PR/issue templates#8
rrahimi-uci wants to merge 3 commits into
mainfrom
chore/community-health-files

Conversation

@rrahimi-uci

Copy link
Copy Markdown
Owner

Goal / Motivation

This repo is public and open to community contributions. GitHub's community health profile flagged several missing files: code of conduct, security policy, PR template, and issue templates.

What changed

  • Added CODE_OF_CONDUCT.md (Contributor Covenant 2.1).
  • Added SECURITY.md with private vulnerability reporting instructions.
  • Added .github/pull_request_template.md.
  • Added .github/ISSUE_TEMPLATE/bug_report.md, feature_request.md, and config.yml.

Why this approach

Reuses the same Contributor Covenant text and templates already adopted by this account's higher-scoring repos, for consistency.

Testing

Docs-only change; no code paths affected.

Risks / limitations

None — purely additive documentation/config files.

Docs / config implications

Raises the repo's GitHub community health score; no other config changes.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds standard GitHub “community health” documentation and templates to make it easier and safer for external contributors to collaborate with this public repository.

Changes:

  • Added a security policy (SECURITY.md) describing private vulnerability reporting and supported versions.
  • Added a code of conduct (CODE_OF_CONDUCT.md) based on Contributor Covenant v2.1.
  • Added GitHub PR and issue templates under .github/ to standardize incoming contributions.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
SECURITY.md Introduces guidance for private vulnerability reporting and version support expectations.
CODE_OF_CONDUCT.md Adds community behavior expectations and enforcement language.
.github/pull_request_template.md Standardizes PR summaries, testing notes, and a submission checklist.
.github/ISSUE_TEMPLATE/bug_report.md Adds a structured bug report template including environment details.
.github/ISSUE_TEMPLATE/feature_request.md Adds a structured feature request template.
.github/ISSUE_TEMPLATE/config.yml Enables blank issues alongside templates.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread SECURITY.md Outdated
Comment thread CODE_OF_CONDUCT.md Outdated
…ruff format check

Co-authored-by: rrahimi-uci <145064767+rrahimi-uci@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated no new comments.

Suppressed comments (1)

CODE_OF_CONDUCT.md:25

  • The Code of Conduct routes behavioral complaints to GitHub’s private vulnerability reporting, which is intended for security disclosures and can confuse triage and reporters. It’s better to direct CoC reports to a maintainer contact channel (and keep SECURITY.md for vulnerabilities).
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported via GitHub's private vulnerability reporting (**Security → Report a vulnerability**) or by contacting a project maintainer directly through GitHub. All complaints will be reviewed and investigated promptly and fairly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants