From 6d3d80204908c6385872c8cab361c06c03f9a6bf Mon Sep 17 00:00:00 2001 From: Tallis Jordan Date: Fri, 23 Oct 2026 18:28:45 -0400 Subject: [PATCH] Add module research issue template and fix Core module order Add a Module Research issue template for coordinating the design of each Core module before lesson writing begins. Research is complete when a PR merges the module README (objectives, lesson list, scope, and boundaries with adjacent modules) and module-metadata.yml. Swap Telemetry & Data (now 2) and Detection Requirements (now 3) in ROADMAP.md and core/README.md to match the order agreed in the Core curriculum discussion (#2). Signed-off-by: Tallis Jordan --- .github/ISSUE_TEMPLATE/module-research.md | 84 +++++++++++++++++++++++ ROADMAP.md | 4 +- core/README.md | 4 +- 3 files changed, 88 insertions(+), 4 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/module-research.md diff --git a/.github/ISSUE_TEMPLATE/module-research.md b/.github/ISSUE_TEMPLATE/module-research.md new file mode 100644 index 0000000..ef0395f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/module-research.md @@ -0,0 +1,84 @@ +--- +name: Module Research +about: Use this template to coordinate the research and lesson design for a Core module + before lesson writing begins. +title: "[RESEARCH] " +labels: core, research +assignees: '' + +--- + +## Module + +Module number and name (e.g. `02 Telemetry & Data`). + +Target directory: `core/NN-slug/` + +## Purpose + +What this module is for and where it sits in the Core sequence. + +## Goal of This Issue + +Design the module's structure so individual lessons can be claimed and written. This issue does **not** produce lesson content. + +Research is complete when a pull request is merged that adds: + +- `core/NN-slug/README.md`, based on [`templates/module-template.md`](https://github.com/HardCounterIO/ode/blob/main/templates/module-template.md), containing: + - module learning objectives + - prerequisites + - the proposed lesson list, with for each lesson: + - 2–4 learning objectives + - key topics + - explicitly out of scope + - a **Boundaries** section describing what this module covers versus adjacent modules +- `core/NN-slug/module-metadata.yml`, based on [`templates/module-metadata.yml`](https://github.com/HardCounterIO/ode/blob/main/templates/module-metadata.yml), with `status: draft` + +Once merged, a maintainer opens one issue per lesson as a sub-issue of this one. + +## Inputs + +### Community Feedback + +Feedback from curriculum discussions that should be addressed in this module. Link the original comments. + +- + +### Seed Material + +Existing material to use as a starting point. Seed material is an input to evaluate, not a finished structure. + +- + +### References + +Standards, frameworks, research, or other references relevant to this module. + +- + +## Known Overlaps + +Topics that touch adjacent modules and need an agreed boundary. + +| Topic | This module | Other module(s) | +|---|---|---| +| | | | + +## How to Participate + +- **Claim:** comment on this issue to join. A maintainer will assign you and add you to the Contributors section below. Multiple contributors may claim the same research issue. +- **Lead:** a maintainer designates one contributor as lead. The lead coordinates, keeps work moving, and opens the pull request. The lead does not make every decision alone. +- **Suggest inputs:** only maintainers can edit this issue, so post feedback, seed material, references, or overlaps as comments and a maintainer will add them above. +- **Collaborate:** use this issue to coordinate. The lead forks the repository and opens a draft pull request early so everyone works from the same document. To let co-contributors push to that branch, the lead adds them as collaborators on their fork (fork **Settings → Collaborators**). Contributors who are not added can propose edits with suggested changes in the pull request review. Every commit must be signed off ([DCO](https://github.com/HardCounterIO/ode/blob/main/CONTRIBUTING.md#developer-certificate-of-origin)). +- **Boundary review:** before merging, a contributor from each adjacent module, or a maintainer, confirms the Boundaries section. +- **Inactivity:** claims with no activity for 4 weeks may be released after a reminder. + +## Contributors + +Lead: + +Contributors: + +## Additional Context + +Anything else relevant to the research for this module? diff --git a/ROADMAP.md b/ROADMAP.md index 46cbaaa..ed22362 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -18,8 +18,8 @@ Develop and review the vendor neutral Detection Engineering Core. Initial areas include: 1. Detection Engineering Foundations -2. Detection Requirements -3. Telemetry & Data +2. Telemetry & Data +3. Detection Requirements 4. Detection Design 5. Detection Development 6. Testing & Validation diff --git a/core/README.md b/core/README.md index b06fb9d..c95e1d7 100644 --- a/core/README.md +++ b/core/README.md @@ -7,8 +7,8 @@ The Core curriculum contains vendor-neutral knowledge applicable to Detection En ## Proposed Areas 1. Detection Engineering Foundations -2. Detection Requirements -3. Telemetry & Data +2. Telemetry & Data +3. Detection Requirements 4. Detection Design 5. Detection Development 6. Testing & Validation