Skip to content

Commit 57536a1

Browse files
authored
feat: add a general issue template (#15)
* docs: propose a new issue * docs: propose a new issue chinese * feat: add issue template * feat: add general issue template
1 parent 4f6f881 commit 57536a1

3 files changed

Lines changed: 60 additions & 0 deletions

File tree

.github/ISSUE_TEMPLATE/general.yml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: 💡 Proposal / 🐞 Bug Report
2+
description: Suggest a new Criteria, Feature, or report a Bug
3+
title: "[Proposal]: "
4+
labels: ["triage"]
5+
body:
6+
- type: dropdown
7+
id: type
8+
attributes:
9+
label: What type of issue is this?
10+
options:
11+
- New Criteria Proposal
12+
- Feature Request
13+
- Bug Report
14+
validations:
15+
required: true
16+
17+
- type: textarea
18+
id: summary
19+
attributes:
20+
label: Summary
21+
description: Please provide a clear and concise description of the issue or idea.
22+
placeholder: |
23+
e.g., I'd like to propose a new criteria relateed to category X, or I found a bug in the existing criteria Y.
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: context
29+
attributes:
30+
label: Context or Motivation
31+
description: |
32+
Why is this criteria/feature important or what problem does the bug cause?
33+
placeholder: |
34+
This proposal improves the maturity assessment by adding criteria for X, or this bug causes issues with Y.
35+
validations:
36+
required: false
37+
38+
- type: textarea
39+
id: details
40+
attributes:
41+
label: Additional Details
42+
description: Optional — provide any additional information that might help in understanding the issue or proposal.
43+
placeholder: |
44+
e.g., examples, screenshots, or any other relevant information.
45+
validations:
46+
required: false
47+
48+
- type: checkboxes
49+
id: agreement
50+
attributes:
51+
label: Checklist
52+
options:
53+
- label: I've searched the existing issues to avoid duplicates.
54+
required: true
55+
- label: I'm willing to help implement or discuss this further if needed.
56+
required: false

content/_index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ DevOps Maturity Specification provides guidelines for DevOps best practices, aim
4747
- 🟢 Must-Have (Weight: 1)
4848
- 🟡 Nice-to-Have (Weight: 0.5)
4949

50+
_Proposed a new criterion?_ Please [open an issue](https://github.com/devops-maturity/devops-maturity/issues/new).
51+
5052
## Badge Levels
5153

5254
Your score will generate one of the following badges:

content/_index.zh.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ DevOps 成熟度规范为 DevOps 最佳实践提供指导,旨在提升软件
4949
- 🟢 必选(权重 1)
5050
- 🟡 可选(权重 0.5)
5151

52+
_提出新的评估项?_[提交 issue](https://github.com/devops-maturity/devops-maturity/issues/new)
53+
5254
## 徽章等级
5355

5456
你的得分将获得以下徽章之一:

0 commit comments

Comments
 (0)