Skip to content

Commit 01d87be

Browse files
selgebaliselgebali
committed
added issue templates
1 parent 673d45c commit 01d87be

File tree

5 files changed

+258
-0
lines changed

5 files changed

+258
-0
lines changed

‎.github/DISCUSSION_TEMPLATE/rfc.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,3 +107,4 @@ body:
107107
2. Regenerate manifest
108108
3. Update docs/examples
109109
4. Open implementation issue(s)
110+

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
name: Bug Report
2+
description: Report a bug in schema artifacts, manifests, contexts, or site/index pages
3+
title: "[Bug] "
4+
labels:
5+
- bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for reporting a bug.
11+
12+
Use this form for defects in published files, generated indexes, manifests, or documentation behavior.
13+
For new proposals or schema changes, use **Discussions** (RFCs) instead.
14+
15+
- type: dropdown
16+
id: area
17+
attributes:
18+
label: Affected Area
19+
options:
20+
- class definitions
21+
- property definitions
22+
- controlled vocabularies
23+
- JSON-LD contexts
24+
- manifest files
25+
- index pages / docs site
26+
- scripts / tooling
27+
- other
28+
validations:
29+
required: true
30+
31+
- type: input
32+
id: url_or_file
33+
attributes:
34+
label: Affected URL or File
35+
description: Link or file path where the bug occurs
36+
placeholder: /linked-data/property/identifier.jsonld or manifest/datacite-4.6.json
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: summary
42+
attributes:
43+
label: Summary
44+
description: Briefly describe the bug
45+
placeholder: What is wrong?
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
id: steps
51+
attributes:
52+
label: Steps To Reproduce
53+
description: Include exact steps, URLs, commands, or inputs
54+
placeholder: |
55+
1. Open ...
56+
2. Run ...
57+
3. Observe ...
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
id: expected
63+
attributes:
64+
label: Expected Behavior
65+
placeholder: What should have happened?
66+
validations:
67+
required: true
68+
69+
- type: textarea
70+
id: actual
71+
attributes:
72+
label: Actual Behavior
73+
placeholder: What happened instead?
74+
validations:
75+
required: true
76+
77+
- type: textarea
78+
id: evidence
79+
attributes:
80+
label: Evidence (Optional)
81+
description: Error messages, screenshots, diffs, or snippets
82+
render: markdown
83+
84+
- type: input
85+
id: environment
86+
attributes:
87+
label: Environment (Optional)
88+
description: Browser/tool/runtime if relevant
89+
placeholder: Chrome 122, curl 8.x, node 20.x
90+
91+
- type: checkboxes
92+
id: checks
93+
attributes:
94+
label: Checklist
95+
options:
96+
- label: I confirmed this is a bug (not a proposal/RFC)
97+
required: true
98+
- label: I searched existing issues for duplicates
99+
required: true
100+

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: RFC / Proposal (GitHub Discussions)
4+
url: https://github.com/datacite/schema.datacite.org-linked-data/discussions/new?category=proposals
5+
about: Use Discussions for schema/vocabulary/context/manifest proposals and RFCs.
6+
- name: General Discussions
7+
url: https://github.com/datacite/schema.datacite.org-linked-data/discussions
8+
about: Ask design questions or gather feedback before opening implementation issues.
9+

‎.github/ISSUE_TEMPLATE/documentation_improvement.yml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Documentation / Site Improvement
2+
description: Suggest improvements to README, CONTRIBUTING, landing page, or section index pages
3+
title: "[Docs] "
4+
labels:
5+
- documentation
6+
body:
7+
- type: dropdown
8+
id: docs_area
9+
attributes:
10+
label: Area
11+
options:
12+
- README.md
13+
- CONTRIBUTING.md
14+
- /linked-data/ landing page
15+
- class index page
16+
- property index page
17+
- vocab index page
18+
- context index page
19+
- manifest index page
20+
- other docs
21+
validations:
22+
required: true
23+
24+
- type: input
25+
id: affected_url_or_file
26+
attributes:
27+
label: Affected URL or File
28+
placeholder: /linked-data/index.html or README.md
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: current_problem
34+
attributes:
35+
label: Current Problem
36+
description: What is unclear, missing, or incorrect?
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: proposed_improvement
42+
attributes:
43+
label: Proposed Improvement
44+
description: What should change?
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: audience
50+
attributes:
51+
label: Intended Audience (Optional)
52+
description: Who would benefit most from this change?
53+
placeholder: Newcomers, metadata engineers, implementers, maintainers, etc.
54+
55+
- type: checkboxes
56+
id: docs_checks
57+
attributes:
58+
label: Checklist
59+
options:
60+
- label: I checked the current docs/pages before filing this request
61+
required: true
62+
- label: This request is about documentation/site UX (not a schema RFC)
63+
required: true

‎.github/ISSUE_TEMPLATE/implementation_task.yml‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
name: Implementation Task
2+
description: Track accepted work (schema updates, manifest regeneration, docs/index changes)
3+
title: "[Task] "
4+
labels:
5+
- task
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Use this form for implementation work.
11+
12+
If the change is still being debated or proposed, open a **Discussion (RFC)** first.
13+
14+
- type: dropdown
15+
id: task_type
16+
attributes:
17+
label: Task Type
18+
options:
19+
- schema artifact update
20+
- vocabulary update
21+
- context update
22+
- manifest regeneration
23+
- docs / index page update
24+
- tooling / script update
25+
- release / deployment task
26+
- other
27+
validations:
28+
required: true
29+
30+
- type: input
31+
id: related_discussion
32+
attributes:
33+
label: Related Discussion / RFC (Optional)
34+
description: Link the accepted RFC discussion if applicable
35+
placeholder: https://github.com/.../discussions/123
36+
37+
- type: textarea
38+
id: problem
39+
attributes:
40+
label: Task Summary
41+
description: What needs to be implemented?
42+
placeholder: Describe the work item and intended outcome.
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: scope
48+
attributes:
49+
label: Scope
50+
description: What files, resources, or areas are expected to change?
51+
placeholder: |
52+
- class/...
53+
- property/...
54+
- manifest/datacite-4.6.json
55+
- index.html
56+
validations:
57+
required: true
58+
59+
- type: textarea
60+
id: acceptance
61+
attributes:
62+
label: Acceptance Criteria
63+
placeholder: |
64+
- [ ] Criteria 1
65+
- [ ] Criteria 2
66+
- [ ] Manifest/index regenerated if needed
67+
validations:
68+
required: true
69+
70+
- type: textarea
71+
id: notes
72+
attributes:
73+
label: Implementation Notes (Optional)
74+
description: Constraints, dependencies, rollout notes, or risks
75+
76+
- type: checkboxes
77+
id: checklist
78+
attributes:
79+
label: Checklist
80+
options:
81+
- label: This is implementation work (not a new proposal/RFC)
82+
required: true
83+
- label: I linked the relevant RFC discussion if one exists
84+
required: false
85+

0 commit comments

Comments
 (0)