From e224cece7cf00aa1e4ec34f69371fe1cf526791a Mon Sep 17 00:00:00 2001 From: Bradley Rule Date: Sun, 2 Nov 2025 21:21:32 -0800 Subject: [PATCH 1/2] Updated issues & planning --- documentation/CONTRIBUTING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/documentation/CONTRIBUTING.md b/documentation/CONTRIBUTING.md index a1159a3..4b2687b 100644 --- a/documentation/CONTRIBUTING.md +++ b/documentation/CONTRIBUTING.md @@ -40,6 +40,29 @@ We will use the feature-branch workflow with all merges handled through PRs. ## Issues & Planning Explain how to file issues, required templates/labels, estimation, and triage/assignment practices. + +Issue titles should start with the following tags to designate intent: +- `FEAT:` New feature request. + - Include problem and feature description within issue description field. + - Include note of requirement ID where applicable (ex: `Requirement ID: REQ-005`). +- `BUG:` Bug report. + - Include problem description. +- `DOC:` Documentation changes. + - Brief description of what needs to be changed or added. + +Example: +``` +FEAT: Example Issue + +Requirement ID: REQ-XXX + +Problem Desciption: +- Brief explanation of why this is important + +Feature Description: +- Brief explanation of expected implementation +``` + ## Commit Messages We will use the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) format for clarity and traceability From 90303960f6f538ca2f3556d62d3cbf078b079115 Mon Sep 17 00:00:00 2001 From: Bradley Rule Date: Sun, 2 Nov 2025 21:29:57 -0800 Subject: [PATCH 2/2] removed extra text from template --- documentation/CONTRIBUTING.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/documentation/CONTRIBUTING.md b/documentation/CONTRIBUTING.md index 4b2687b..129d3df 100644 --- a/documentation/CONTRIBUTING.md +++ b/documentation/CONTRIBUTING.md @@ -38,9 +38,6 @@ We will use the feature-branch workflow with all merges handled through PRs. * ```bugfix/short-name``` * Rebase your working branch with main, and often, before submitting a PR (simpler conflict resolution) ## Issues & Planning -Explain how to file issues, required templates/labels, estimation, and -triage/assignment practices. - Issue titles should start with the following tags to designate intent: - `FEAT:` New feature request. - Include problem and feature description within issue description field.