Skip to content

docs: add contributing guide, issue forms and a working PR template - #176

Merged
mrsumanbiswas merged 1 commit into
CommandLineCoding:mainfrom
mrsumanbiswas:84-contributing-guide-and-templates
Nov 7, 2026
Merged

mrsumanbiswas merged 1 commit into
CommandLineCoding:mainfrom
mrsumanbiswas:84-contributing-guide-and-templates

Conversation

@mrsumanbiswas

Copy link
Copy Markdown
Member

Closes #84. Part of the roadmap restructure (default branch is now main).

@Golden-Eagle07 this covers #84, which is assigned to you. Your review would be great.

Added

  • CONTRIBUTING.md: 10-minute setup (Compose server, app pointed at it from the emulator or a phone via adb reverse), a map of where things live, claiming issues, branch <num>-<slug> and commit conventions, the checks to run, and rules for migrations and API changes.
  • Issue forms (bug_report.yml, feature_request.yml) that ask for area, app version, device and server, and add needs triage. The chooser (config.yml) links to Discussions Q&A and Ideas, and to private security reporting.

Fixed

  • The PR template was in .github/ISSUE_TEMPLATE/, so GitHub never used it. It now lives at .github/pull_request_template.md, with a migration checkbox and an API-docs checkbox.
  • The bug template file was misnamed (but_report.md). It's replaced by the form.

README: the Contributing section now links to CONTRIBUTING, good first issues, milestones and Discussions.

- CONTRIBUTING.md: setup (server via Compose, app pointed at a local
  server), where things live, how to claim an issue, branch/commit
  conventions, checks to run, and rules for migrations and API changes.
- Issue templates become forms (bug, feature) that ask for area, version
  and device, and add "needs triage". The chooser links to Discussions
  Q&A/Ideas and to private security reporting.
- Move the PR template to .github/, where GitHub actually picks it up,
  and add a migration checkbox.
- README points to CONTRIBUTING, good first issues and milestones.

Closes CommandLineCoding#84
@mrsumanbiswas
mrsumanbiswas merged commit 2fdc91a into CommandLineCoding:main Nov 7, 2026
1 check passed
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]: PR template and Contributing

1 participant