Skip to content

docs: add code of conduct and issue/PR templates - #60

Merged
nedpals merged 1 commit into
nedpals:masterfrom
Furox-Art:docs/community-health-files
Oct 13, 2026
Merged

nedpals merged 1 commit into
nedpals:masterfrom
Furox-Art:docs/community-health-files

Conversation

@Furox-Art

Copy link
Copy Markdown
Contributor

Summary

Adds community health files so new contributors start from a clear place, and fills the two open documentation gaps.

Closes #58
Closes #57

What changed

  • CODE_OF_CONDUCT.md — Contributor Covenant v2.1, the standard used by most open-source projects. The reporting contact is left as a placeholder ([INSERT CONTACT METHOD]) as requested in Add a Code of Conduct #58; the maintainer fills it in before merge.
  • .github/ISSUE_TEMPLATE/bug_report.md — asks for steps to reproduce, expected vs. actual behavior, browser and device, and whether the reporter is on a display or a controller (the two roles this app is built around).
  • .github/ISSUE_TEMPLATE/feature_request.md — problem/opportunity, proposed change, and which role it helps.
  • .github/pull_request_template.md — short description prompt, a Closes # line, and the checklist copied from the "PR checklist" section of CONTRIBUTING.md.
  • CONTRIBUTING.md — new "Code of Conduct" section linking the new file, as Add a Code of Conduct #58 requires.
  • README.md — links the Code of Conduct from the Development section.

Markdown templates were used (rather than .yml issue forms) because #57 names the exact .md file paths; the two forms are interchangeable in GitHub's template chooser.

Test plan

Docs-only change, no code touched:

  • Templates render in GitHub's "New issue" chooser (both bug report and feature request listed)
  • New PRs are prefilled with the PR checklist
  • Links from README.md and CONTRIBUTING.md resolve to CODE_OF_CONDUCT.md
  • git status shows only the intended files changed

Notes for review

  • The CoC contact placeholder must be confirmed by the maintainer before this can merge (Add a Code of Conduct #58 states this explicitly).
  • No CI-affecting files changed; uv run pytest, npm run lint, and npm run build are untouched.

@nedpals nedpals left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Approved. Thanks for looking into this!

@nedpals
nedpals merged commit 116c275 into nedpals:master Oct 13, 2026
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.

Add a Code of Conduct Add issue and pull request templates

2 participants