Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commita26b49d

Browse files
committed
Use form-based issue templates
High quality feedback via GitHub issues is a very valuable contribution to the project. It is important to make theissue creation and management process as efficient as possible for the contributors, maintainers, and developers.Issue templates are helpful to the maintainers and developers because it establishes a standardized framework for theissues and encourages the contributors to provide the essential information.The contributor is now presented with a web form when creating an issue. This consists of multi-line input fields thathave the same formatting, preview, and attachment capabilities as the standard GitHub Issue composer, in addition tomenus and checkboxes where appropriate.The use of this form-based system should provide a much better experience for the contributors and also result in higherquality issues by establishing a standardized framework for the issues and encouraging contributors to provide theessential information.A template chooser allows the contributor to select the appropriate template type, redirects support requests to theappropriate communication channels via "Contact Links", and provides a prominent link to security policy to guide anyvulnerability disclosures.The clear separation of the types of issues encourages the reporter to fit their report into a specific issue category,resulting in more clarity. Automatic labeling according to template choice allows the reporter to do the initialclassification.
1 parent78259af commita26b49d

File tree

3 files changed

+124
-0
lines changed

3 files changed

+124
-0
lines changed
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/general/bug-report.yml
2+
# See: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
3+
4+
name:Bug report
5+
description:Report a problem with the code or documentation in this repository.
6+
labels:
7+
-"type: imperfection"
8+
body:
9+
-type:textarea
10+
id:description
11+
attributes:
12+
label:Describe the problem
13+
validations:
14+
required:true
15+
-type:textarea
16+
id:reproduce
17+
attributes:
18+
label:To reproduce
19+
description:Provide the specific set of steps we can follow to reproduce the problem.
20+
validations:
21+
required:true
22+
-type:textarea
23+
id:expected
24+
attributes:
25+
label:Expected behavior
26+
description:What would you expect to happen after following those instructions?
27+
validations:
28+
required:true
29+
-type:input
30+
id:project-version
31+
attributes:
32+
label:"'arduino/setup-arduino-cli' version"
33+
description:|
34+
Which version of `arduino/setup-arduino-cli` are you using?
35+
_This should be the most recent version available._
36+
validations:
37+
required:true
38+
-type:textarea
39+
id:additional
40+
attributes:
41+
label:Additional context
42+
description:Add any additional information here.
43+
validations:
44+
required:false
45+
-type:checkboxes
46+
id:checklist
47+
attributes:
48+
label:Issue checklist
49+
description:Please double-check that you have done each of the following things before submitting the issue.
50+
options:
51+
-label:I searched for previous reports in [the issue tracker](https://github.com/arduino/setup-arduino-cli/issues?q=)
52+
required:true
53+
-label:I verified the problem still occurs when using the latest version
54+
required:true
55+
-label:My report contains all necessary details
56+
required:true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/template-choosers/github-actions/config.yml
2+
# See: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
3+
4+
blank_issues_enabled:false
5+
contact_links:
6+
-name:Learn about using this project
7+
url:https://github.com/arduino/setup-arduino-cli#readme
8+
about:Detailed usage documentation is available here.
9+
-name:Learn about GitHub Actions
10+
url:https://docs.github.com/actions
11+
about:Everything you need to know to get started with GitHub Actions.
12+
-name:Support request
13+
url:https://forum.arduino.cc/
14+
about:We can help you out on the Arduino Forum!
15+
-name:Discuss development work on the project
16+
url:https://groups.google.com/a/arduino.cc/g/developers
17+
about:Arduino Developers Mailing List
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/general/bug-report.yml
2+
# See: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
3+
4+
name:Feature request
5+
description:Suggest an enhancement to this project.
6+
labels:
7+
-"type: enhancement"
8+
body:
9+
-type:textarea
10+
id:description
11+
attributes:
12+
label:Describe the request
13+
validations:
14+
required:true
15+
-type:textarea
16+
id:current
17+
attributes:
18+
label:Describe the current behavior
19+
description:|
20+
What is the current behavior of `arduino/setup-arduino-cli` in relation to your request?
21+
How can we reproduce that behavior?
22+
validations:
23+
required:true
24+
-type:input
25+
id:project-version
26+
attributes:
27+
label:"'arduino/setup-arduino-cli' version"
28+
description:|
29+
Which version of `arduino/setup-arduino-cli` are you using?
30+
_This should be the most recent version available._
31+
validations:
32+
required:true
33+
-type:textarea
34+
id:additional
35+
attributes:
36+
label:Additional context
37+
description:Add any additional information here.
38+
validations:
39+
required:false
40+
-type:checkboxes
41+
id:checklist
42+
attributes:
43+
label:Issue checklist
44+
description:Please double-check that you have done each of the following things before submitting the issue.
45+
options:
46+
-label:I searched for previous requests in [the issue tracker](https://github.com/arduino/setup-arduino-cli/issues?q=)
47+
required:true
48+
-label:I verified the feature was still missing when using the latest version
49+
required:true
50+
-label:My request contains all necessary details
51+
required:true

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp