From 52aa4a7efabb462c3c4362710f5c9bcc250e86d3 Mon Sep 17 00:00:00 2001 From: Meysam Parvizi Date: Fri, 9 Oct 2026 17:56:22 +0200 Subject: [PATCH] chore(github): add issue forms for resources, link problems and roadmap changes --- .github/ISSUE_TEMPLATE/config.yml | 5 ++ .../ISSUE_TEMPLATE/report-link-problem.yml | 45 +++++++++++ .github/ISSUE_TEMPLATE/suggest-resource.yml | 78 +++++++++++++++++++ .../suggest-topic-or-structure.yml | 36 +++++++++ 4 files changed, 164 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/report-link-problem.yml create mode 100644 .github/ISSUE_TEMPLATE/suggest-resource.yml create mode 100644 .github/ISSUE_TEMPLATE/suggest-topic-or-structure.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..191fe1c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Contributing guidelines + url: https://github.com/m3y54m/Embedded-Engineering-Roadmap/blob/master/CONTRIBUTING.md + about: Read these before suggesting a resource or opening a pull request. diff --git a/.github/ISSUE_TEMPLATE/report-link-problem.yml b/.github/ISSUE_TEMPLATE/report-link-problem.yml new file mode 100644 index 0000000..5d1e938 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/report-link-problem.yml @@ -0,0 +1,45 @@ +name: Report a link problem +description: A link is broken, moved, mislabeled, off-topic or in the wrong section +title: "[Link] " +labels: ["link-problem"] +body: + - type: markdown + attributes: + value: | + Use this form for any problem with an existing entry. Select every problem that applies. + If you already know the fix, a pull request is welcome too. + - type: input + id: entry + attributes: + label: Entry + description: The title or URL of the entry, and the section it is in. + validations: + required: true + - type: dropdown + id: problems + attributes: + label: What is wrong? + multiple: true + options: + - Link is broken (404, domain gone, site down) + - Link moved to a new address + - Link opens something different from its title + - Content is outdated + - Content is not related to the section it is in + - Wrong type marker or quality marker (📘 🎞️ 📝 🔗 👶 💎) + - Site is unsafe, spammy or requires an unexpected paywall + - Duplicate of another entry + validations: + required: true + - type: textarea + id: details + attributes: + label: Details + description: What you saw, and when. Include the error message if there is one. + validations: + required: true + - type: textarea + id: fix + attributes: + label: Suggested fix (optional) + description: A replacement link, a better section, the correct marker, or "remove it". diff --git a/.github/ISSUE_TEMPLATE/suggest-resource.yml b/.github/ISSUE_TEMPLATE/suggest-resource.yml new file mode 100644 index 0000000..4ff80b8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/suggest-resource.yml @@ -0,0 +1,78 @@ +name: Suggest a resource +description: Propose a book, video, article or tool to add to the roadmap +title: "[Resource] " +labels: ["resource"] +body: + - type: markdown + attributes: + value: | + Thanks for contributing! Please read the [contributing guidelines](https://github.com/m3y54m/Embedded-Engineering-Roadmap/blob/master/CONTRIBUTING.md) first. + Free resources are preferred, and each entry needs a clear reason to be there. + - type: input + id: url + attributes: + label: Link + placeholder: https:// + validations: + required: true + - type: input + id: title + attributes: + label: Title and author + description: As it should appear in the list, for example "Title - Author". + validations: + required: true + - type: dropdown + id: type + attributes: + label: Resource type + options: + - "📘 Book" + - "🎞️ Video" + - "📝 Article or blog post" + - "🔗 Other (tool, documentation, website)" + - "🎧 Audio book" + validations: + required: true + - type: input + id: section + attributes: + label: Section it belongs to + description: Heading in the README where it fits best. If you are not sure, describe the topic. + placeholder: "Microcontrollers > Interrupts" + validations: + required: true + - type: dropdown + id: level + attributes: + label: Audience + options: + - Beginner-friendly (👶) + - Intermediate + - Advanced + - Well-known, comprehensive reference (💎) + multiple: true + validations: + required: true + - type: dropdown + id: cost + attributes: + label: Cost + options: + - Free + - Free with registration + - Paid + validations: + required: true + - type: textarea + id: why + attributes: + label: Why should it be included? + description: If it is paid, explain why it is clearly better than the free options already listed. + validations: + required: true + - type: input + id: replaces + attributes: + label: Replaces an existing entry (optional) + description: Name or link of the entry this would replace, if any. diff --git a/.github/ISSUE_TEMPLATE/suggest-topic-or-structure.yml b/.github/ISSUE_TEMPLATE/suggest-topic-or-structure.yml new file mode 100644 index 0000000..bfb8518 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/suggest-topic-or-structure.yml @@ -0,0 +1,36 @@ +name: Suggest a topic or structure change +description: Propose a new topic, a missing section, or a reorganization +title: "[Roadmap] " +labels: ["roadmap"] +body: + - type: markdown + attributes: + value: | + New topics should be useful to other learners and fit the roadmap's structure. See the "Roadmap Alignment" section of the [contributing guidelines](https://github.com/m3y54m/Embedded-Engineering-Roadmap/blob/master/CONTRIBUTING.md). + - type: dropdown + id: kind + attributes: + label: What do you suggest? + multiple: true + options: + - Add a new topic or section + - Move or reorganize existing sections + - Change the roadmap diagram + - Improve the introduction or explanations + - Other + validations: + required: true + - type: textarea + id: proposal + attributes: + label: Proposal + description: Describe the change and where it would go. + validations: + required: true + - type: textarea + id: why + attributes: + label: Why does it help learners? + description: Which skill or job role it covers, and why it is missing today. + validations: + required: true