chore(github): simplify issue forms and PR template

This commit is contained in:
Meysam Parvizi
2026-10-09 18:02:24 +02:00
parent 52aa4a7efa
commit f436b82539
4 changed files with 18 additions and 139 deletions
+7 -33
View File
@@ -1,45 +1,19 @@
name: Report a link problem
description: A link is broken, moved, mislabeled, off-topic or in the wrong section
description: A link is broken, outdated, mislabeled or in the wrong section
title: "[Link] "
labels: ["link-problem"]
labels: ["bug"]
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
label: Which link?
description: The title or URL of the entry.
validations:
required: true
- type: textarea
id: details
id: problem
attributes:
label: Details
description: What you saw, and when. Include the error message if there is one.
label: What is wrong, and what should happen to it?
description: For example "returns 404, replace with <link>" or "belongs under Debugging".
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".
+6 -58
View File
@@ -1,13 +1,8 @@
name: Suggest a resource
description: Propose a book, video, article or tool to add to the roadmap
description: Propose a link to add to the roadmap
title: "[Resource] "
labels: ["resource"]
labels: ["enhancement"]
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:
@@ -15,64 +10,17 @@ body:
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
label: Where does it belong?
description: The README section, for example "Microcontrollers > Interrupts".
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.
label: Why add it?
description: One or two sentences. Mention if it is paid or aimed at beginners.
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.
@@ -1,36 +0,0 @@
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
+5 -12
View File
@@ -1,14 +1,7 @@
# What this changes
# What changed
<!-- Added / moved / removed resources, and the section(s) affected -->
<!-- Added, moved or removed entries, and the section -->
## Checklist
Based on [CONTRIBUTING.md](../CONTRIBUTING.md).
- [ ] Each entry uses `- [<type>[👶][💎] Title](url)` with the markers explained in the README
- [ ] The resource fits the section it is placed in
- [ ] The link opens and the content matches the title
- [ ] Free resources are preferred; a paid one is included only if clearly better than the free options
- [ ] No pile of entries from a single author or creator without a clear reason
- [ ] Advanced material is labeled as such, so beginners are not overwhelmed
- [ ] Entries follow the format and markers described in the README
- [ ] Each link works and matches its section
- [ ] Each addition has a clear reason (free resources preferred; see [CONTRIBUTING.md](../CONTRIBUTING.md))