Skip to content

Commit 4f82c1b

Browse files
authored
Merge pull request #59 from danbaruka/main
chore(issues): refresh templates and links; add docs + feature reques… Closes: #31
2 parents 82f3355 + 43dd21c commit 4f82c1b

File tree

5 files changed

+104
-50
lines changed

5 files changed

+104
-50
lines changed

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
blank_issues_enabled: true
22
contact_links:
3-
- name: Contributing guidelines
4-
url: https://github.com/xxxx-committee-documentation/blob/master/CONTRIBUTING.md
5-
about: Some rules & processes we honor.
3+
- name: Contribution guidelines
4+
url: https://github.com/IntersectMBO/developer-experience/blob/main/CONTRIBUTING.md
5+
about: Read the documentation and guidelines before filing an issue.
66

7-
- name: Feature ideas
8-
url: https://github.com/xxxx-committee-documentation/discussions/categories/ideas
9-
about: Maybe someone else had the same or a similar idea already?
7+
- name: Ideas and discussions
8+
url: https://github.com/IntersectMBO/developer-experience/discussions
9+
about: Share ideas and proposals or ask open questions.
1010

11-
- name: All issues
12-
url: https://github.com/xxxx-committee-documentation/issues
13-
about: Check whether your issue is not already covered here.
11+
- name: Join Intersect
12+
url: https://members.intersectmbo.org
13+
about: Register with Intersect to access Discord and other community resources.
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Documentation
2+
description: Report an issue or request with the documentation or website
3+
labels: ["documentation"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Use this template to request documentation additions, corrections, or link updates.
9+
10+
- type: input
11+
id: page
12+
attributes:
13+
label: Page or section
14+
description: Which page, path, or section needs an update?
15+
placeholder: contributor-beginner/docs/tutorial-basics/directive-kickoff.md
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
id: issue
21+
attributes:
22+
label: Issue description
23+
description: What is wrong or missing?
24+
placeholder: Broken link, outdated content, missing section, formatting, etc.
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: proposal
30+
attributes:
31+
label: Proposed change
32+
description: How should it be updated? Include copy or links if available.
33+
validations:
34+
required: false
35+
36+
- type: checkboxes
37+
id: checks
38+
attributes:
39+
label: Checks
40+
options:
41+
- label: I searched existing issues and discussions
42+
required: true
43+
- label: This is about documentation (not a feature request or bug)
44+
required: true

.github/ISSUE_TEMPLATE/feature_idea.yml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
name: Feature idea
2-
description: Idea or request for some feature on the xxx Committee GitBook
3-
labels: [':thought_balloon: idea']
2+
description: Propose a feature or improvement for Developer Experience
3+
labels: ["idea"]
44
body:
55
- type: markdown
66
attributes:
77
value: |
8-
**Thank you for contributing to our project!** :green_heart:
8+
Thank you for contributing to our project.
99
10-
Instead of opening this issue, consider [starting a new idea discussion](https://github.com/IntersectMBO/xxxx-committee-documentation/discussions/new?category=ideas).
11-
That way, we can discuss & refine your idea together, before we adopt it as a feature into the roadmap.
10+
Consider starting a new idea discussion first:
11+
https://github.com/IntersectMBO/developer-experience/discussions/new?category=ideas
12+
This helps refine the proposal before it becomes a tracked feature.
1213
1314
- type: textarea
1415
id: why
@@ -24,7 +25,7 @@ body:
2425
id: what
2526
attributes:
2627
label: What
27-
description: What is this feature roughly about
28+
description: What is this feature roughly about?
2829
placeholder: |
2930
For example describe a new API endpoint, a change in messaging formats,
3031
a new configuration option, ...
@@ -35,7 +36,7 @@ body:
3536
id: how
3637
attributes:
3738
label: How
38-
description: How could we realize this feature
39+
description: How could we realize this feature?
3940
placeholder: |
4041
Which technical solutions, libraries or systems should be used, which
4142
components need to change, steps how to implement this, ...
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Feature request
2+
description: Request a new feature or enhancement
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Use this template to propose enhancements to Developer Experience tooling, docs, or workflows.
9+
10+
- type: textarea
11+
id: problem
12+
attributes:
13+
label: Problem statement
14+
description: What problem are you trying to solve?
15+
placeholder: Describe the pain point and who it affects.
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
id: solution
21+
attributes:
22+
label: Proposed solution
23+
description: How should we solve it? Include alternatives considered.
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: scope
29+
attributes:
30+
label: Scope and impact
31+
description: Affected areas, risks, and expected outcomes.
32+
validations:
33+
required: false
34+
35+
- type: checkboxes
36+
id: checks
37+
attributes:
38+
label: Checks
39+
options:
40+
- label: I searched existing issues and discussions
41+
required: true
42+
- label: This is a feature/enhancement request (not a question or doc issue)
43+
required: true

.github/ISSUE_TEMPLATE/working_group_update.yml

Lines changed: 0 additions & 34 deletions
This file was deleted.

0 commit comments

Comments
 (0)