Skip to content

docs(contributing): issue-first flow with linked PRs and issue templates - #20

Merged
fleizean merged 3 commits into
developfrom
gsd/quick-261027-contributing-flow
Oct 26, 2026
Merged

fleizean merged 3 commits into
developfrom
gsd/quick-261027-contributing-flow

Conversation

@fleizean

Copy link
Copy Markdown
Member

Summary

Make the issue-first contribution flow the default and document it: open an issue, open a linked pull request early, continue on the pull request.

Why

Closes #18. Today CONTRIBUTING.md only asks for an issue "for a larger change" and nothing ties a pull request back to its issue. Issue-first with a linked PR gives every change a tracked rationale, lets reviewers follow work in progress, and keeps develop history traceable.

Changes

  • CONTRIBUTING.md — every change starts with an issue; branch from develop, open the pull request early (draft is fine), and link it with Closes #NNN. Security still routes through SECURITY.md.
  • .github/pull_request_template.md — a Closes # line in Why and a matching checklist item make the linked issue explicit.
  • .github/ISSUE_TEMPLATE/ — bug_report, feature_request and chore templates, plus config.yml that disables blank issues and points security reports to the private policy.

Notes for reviewers

Checklist

  • This pull request is linked to an issue (Closes #18 above)
  • The pull request targets develop and is about one thing
  • Commit messages follow Conventional Commits (docs: ..., chore: ...)
  • CI is green (backend tests, frontend build and tests, dependency gate)
  • Schema changes are EF Core migrations generated by the tool, not hand-edited (none)
  • A changed backend DTO has its TypeScript twin updated (none)
  • New dependencies are justified and their lock files are updated in the same commit (none)
  • No secrets, tokens or personal data in code, logs or this description
  • Code comments are kept to a minimum; the reasoning lives in this description

Enes Yağız and others added 2 commits October 27, 2026 01:32
Every change starts with an issue; the pull request is opened early
against develop and linked with a closing keyword. The PR template now
carries a required Closes line and checklist item.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Adds the three issue templates plus config.yml, which disables blank
issues and routes security reports to the private policy. Supports the
issue-first contribution flow.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@fleizean
fleizean merged commit 1276dde into develop Oct 26, 2026
5 checks 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.

Adopt issue-first contribution flow with linked PRs

1 participant