Skip to content

Commit 520e95c

Browse files
luisfi-devluisfi-dev
authored
Merge pull request #4 from LuisFerLCC/gh-config
Add Issue templates
2 parents 8cdd23d + 0210135 commit 520e95c

7 files changed

Lines changed: 368 additions & 1 deletion

File tree

‎.editorconfig‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,11 @@ trim_trailing_whitespace = true
1212
quote_type = double
1313
ij_any_keep_blank_lines_in_code = 1
1414

15-
[{*.rs,*.toml}]
15+
[{*.rs,*.toml,*.yml}]
1616
indent_style = space
1717

1818
[*.toml]
1919
max_line_length = 100
20+
21+
[*.yml]
22+
indent_size = 2

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
name: Bug Report
2+
description: Is the macro not working as intended?
3+
title: BUG - (brief description)
4+
labels:
5+
- 🐞 Bug
6+
assignees: LuisFerLCC
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
# Bug Report
13+
14+
**IMPORTANT:** IF YOU WANT TO REPORT A SECURITY VULNERABILITY, PLEASE USE [SECURITY ADVISORIES](https://github.com/LuisFerLCC/error-stack-macros2/security/advisories/new) TO FILE A PRIVATE REPORT.
15+
16+
- type: input
17+
id: crate-version
18+
attributes:
19+
label: Crate version
20+
description: Which crate version are you using? You can find it in your `Cargo.toml` file.
21+
placeholder: X.X.X
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: description
27+
attributes:
28+
label: Description
29+
description: |
30+
Please describe the bug and how to reproduce it in as much detail as possible.
31+
You can also attach images or log files here.
32+
placeholder: |
33+
Steps to reproduce:
34+
1.
35+
2.
36+
3.
37+
...
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: code-sample
43+
attributes:
44+
label: Code sample
45+
description: |
46+
If possible, include a reproducible code sample. The sample should be minimal (with no unnecessary code) but complete.
47+
NOTE: This input will be automatically formatted into Rust code.
48+
render: Rust
49+
placeholder: |
50+
use error_stack_macros2::Error;
51+
52+
#[derive(Debug, Error)]
53+
#[display("Custom error")]
54+
struct CustomError;
55+
56+
- type: textarea
57+
id: expected-behavior
58+
attributes:
59+
label: Expected behavior
60+
validations:
61+
required: true
62+
63+
- type: textarea
64+
id: actual-behavior
65+
attributes:
66+
label: Actual behavior
67+
validations:
68+
required: true
69+
70+
- type: dropdown
71+
id: priority
72+
attributes:
73+
label: Priority
74+
description: How critical is this bug? (please be realistic)
75+
options:
76+
- Minor bug (annoying, but not fundamentally broken)
77+
- Medium bug (needs attention)
78+
- Major bug (must be fixed immediately)
79+
validations:
80+
required: true
81+
82+
- type: checkboxes
83+
id: contribution-guidelines
84+
attributes:
85+
label: Contribution guidelines
86+
description: By submitting this issue, you agree that...
87+
options:
88+
- label: This is a bug, not you [asking for support](https://github.com/LuisFerLCC/error-stack-macros2/discussions/categories/q-a).
89+
required: true
90+
- label: You have read the [documentation](https://docs.rs/error-stack-macros2) and made sure this is not intended behavior.
91+
required: true
92+
- label: The issue has not already been reported.
93+
required: true
94+
- label: You are following the project's [Code of
95+
Conduct](https://github.com/LuisFerLCC/error-stack-macros2/blob/master/.github/CODE_OF_CONDUCT.md) and [contribution
96+
guidelines](https://github.com/LuisFerLCC/error-stack-macros2/blob/master/.github/CONTRIBUTING.md).
97+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
blank_issues_enabled: false
2+
3+
contact_links:
4+
- name: Documentation
5+
url: https://docs.rs/error-stack-macros2
6+
about: Please check the documentation before filing new issues.
7+
8+
- name: Support
9+
url: https://github.com/LuisFerLCC/error-stack-macros2/discussions/categories/q-a
10+
about: Need help? Ask on GitHub discussions!

‎.github/ISSUE_TEMPLATE/docs.yml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Documentation Issue
2+
description: Is there something wrong or missing in the documentation?
3+
title: DOCS - (brief description)
4+
labels:
5+
- 📄 Documentation
6+
assignees: LuisFerLCC
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
# Documentation Issue
13+
14+
- type: input
15+
id: path
16+
attributes:
17+
label: Path to the affected item
18+
placeholder: error_stack_macros2::impl_error_stack
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: description
24+
attributes:
25+
label: Description
26+
description: Please describe the issue in as much detail as possible. You can also attach images here.
27+
placeholder: |
28+
This function needs documentation...
29+
This example references the wrong type...
30+
validations:
31+
required: true
32+
33+
- type: dropdown
34+
id: priority
35+
attributes:
36+
label: Priority
37+
description: How critical is this issue? (please be realistic)
38+
options:
39+
- Minor (not crucially broken)
40+
- Medium (needs attention)
41+
- Major (must be fixed immediately)
42+
validations:
43+
required: true
44+
45+
- type: checkboxes
46+
id: contribution-guidelines
47+
attributes:
48+
label: Contribution guidelines
49+
description: By submitting this issue, you agree that...
50+
options:
51+
- label: This is a documentation issue, not you [asking for
52+
support](https://github.com/LuisFerLCC/error-stack-macros2/discussions/categories/q-a).
53+
required: true
54+
- label: The issue has not already been reported.
55+
required: true
56+
- label: You are following the project's [Code of
57+
Conduct](https://github.com/LuisFerLCC/error-stack-macros2/blob/master/.github/CODE_OF_CONDUCT.md) and [contribution
58+
guidelines](https://github.com/LuisFerLCC/error-stack-macros2/blob/master/.github/CONTRIBUTING.md).
59+
required: true

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Feature Request
2+
description: Do you have a suggestion or an idea for a new feature?
3+
title: SUGGESTION - (brief description)
4+
labels:
5+
- ✨ Enhancement
6+
assignees: LuisFerLCC
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
# Feature Request
13+
14+
**IMPORTANT:** IF YOU WANT TO REPORT A SECURITY VULNERABILITY, PLEASE USE [SECURITY ADVISORIES](https://github.com/LuisFerLCC/error-stack-macros2/security/advisories/new) TO FILE A PRIVATE REPORT.
15+
16+
- type: textarea
17+
id: description
18+
attributes:
19+
label: Description
20+
description: |
21+
Please describe the suggestion in as much detail as possible.
22+
You can also attach images or text files here.
23+
placeholder: |
24+
This new feature would be very welcome...
25+
The lack of ___ is frustrating...
26+
___ should behave like this instead...
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: example-use-cases
32+
attributes:
33+
label: Example use cases
34+
description: When and where would this feature be useful?
35+
placeholder: This would be useful in situations where...
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: other-alternatives
41+
attributes:
42+
label: Other alternatives
43+
description: Have you considered any other possible approaches?
44+
45+
- type: checkboxes
46+
id: contribution-guidelines
47+
attributes:
48+
label: Contribution guidelines
49+
description: By submitting this issue, you agree that...
50+
options:
51+
- label: This is a suggestion, not you [asking for support](https://github.com/LuisFerLCC/error-stack-macros2/discussions/categories/q-a).
52+
required: true
53+
- label: You have read the [documentation](https://docs.rs/error-stack-macros2) and made sure this is not already implemented.
54+
required: true
55+
- label: The issue has not already been suggested.
56+
required: true
57+
- label: This new feature will not break any existing code.
58+
required: true
59+
- label: This feature fits within `error-stack-macros2`'s scope and purpose.
60+
required: true
61+
- label: You are following the project's [Code of
62+
Conduct](https://github.com/LuisFerLCC/error-stack-macros2/blob/master/.github/CODE_OF_CONDUCT.md) and [contribution
63+
guidelines](https://github.com/LuisFerLCC/error-stack-macros2/blob/master/.github/CONTRIBUTING.md).
64+
required: true

‎.github/labels.yml‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
- name: 💣 Breaking change
2+
description: Unintended change that breaks existing behavior
3+
color: "f79f34"
4+
5+
- name: 🐞 Bug
6+
description: Not working as intended
7+
color: "d73a4a"
8+
9+
- name: 💻 Dev Dependencies
10+
description: PRs that update development dependencies
11+
color: "155e8c"
12+
13+
- name: 💬 Discussion
14+
description: This issue or PR is currently being discussed on
15+
color: "6da082"
16+
17+
- name: 📄 Documentation
18+
description: Improvements or additions to the documentation
19+
color: "0075ca"
20+
21+
- name: 🔃 Duplicate
22+
description: This issue or PR already exists
23+
color: "cfd3d7"
24+
25+
- name: ✨ Enhancement
26+
description: New feature or request
27+
color: "a2eeef"
28+
29+
- name: 👍 Good first issue
30+
description: Good for newcomers
31+
color: "7057ff"
32+
33+
- name: 👍 Good first PR
34+
description: Good for newcomers
35+
color: "7057ff"
36+
37+
- name: 🖋️ Has a PR
38+
description: This issue has a corresponding PR
39+
color: "5319e7"
40+
41+
- name: ↪️ Has a workaround
42+
description: A different path can be taken to get the expected result
43+
color: "bfd4f2"
44+
45+
- name: ❔ Help wanted
46+
description: Further support is needed
47+
color: "88eb95"
48+
49+
- name: 🚫 Invalid
50+
description: This doesn't seem right
51+
color: "e4e669"
52+
53+
- name: 🔴 Major bug
54+
description: Severely affects most use cases
55+
color: "e99695"
56+
57+
- name: 🟡 Medium bug
58+
description: Affects several use cases
59+
color: "fef2c0"
60+
61+
- name: 🟢 Minor bug
62+
description: Only affects a very specific use case
63+
color: "c2e0c6"
64+
65+
- name: 📄 Needs documentation
66+
description: Documentation is needed
67+
color: "1d76db"
68+
69+
- name: ❌ Needs rebase
70+
description: There is a merge conflict
71+
color: "261542"
72+
73+
- name: 🧪 Needs tests
74+
description: Unit testing is needed
75+
color: "c23675"
76+
77+
- name: 🍰 Nice to have
78+
description: Unplanned behavior, but useful
79+
color: "c5def5"
80+
81+
- name: ⏳ On hold
82+
description: Development on this issue has been suspended
83+
color: "d4c5f9"
84+
85+
- name: ✅ Ready to merge
86+
description: This PR is ready to be merged
87+
color: "0ff40b"
88+
89+
- name: 🧪 Tests
90+
description: Improvements or additions to unit tests
91+
color: "9f2d60"
92+
93+
- name: ⚙️ Unreproducible
94+
description: The bug cannot be reproduced
95+
color: "808080"
96+
97+
- name: 🔥 Urgent
98+
description: Needs to be fixed ASAP
99+
color: "ff7b00"
100+
101+
- name: 🗑️ Won't fix
102+
description: This will not be worked on
103+
color: "ffffff"
104+
105+
- name: 🆗 Working as intended
106+
description: This is the intended behavior
107+
color: "ebd534"

‎.github/workflows/syncLabels.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Sync issue/PR labels
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
paths:
9+
- .github/labels.yml
10+
11+
workflow_dispatch:
12+
13+
jobs:
14+
sync:
15+
name: Sync labels
16+
runs-on: ubuntu-latest
17+
if: github.repository_owner == 'LuisFerLCC'
18+
19+
steps:
20+
- name: Checkout repository
21+
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
22+
23+
- name: Sync with GitHub Labeler
24+
uses: crazy-max/ghaction-github-labeler@24d110aa46a59976b8a7f35518cb7f14f434c916
25+
26+
with:
27+
github-token: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)