Skip to content

Commit 1cb9c71

Browse files
drprojectsdrprojects
committed
adding issue templates
1 parent a8823a9 commit 1cb9c71

File tree

5 files changed

+225
-0
lines changed

5 files changed

+225
-0
lines changed

‎.github/ISSUE_TEMPLATE/0-bug-report.yaml

+101
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
name: "🐛 Bug Report"
2+
description: Submit a report to help us reproduce and fix the bug
3+
title: Title of your bug report
4+
labels: ["bug"]
5+
6+
body:
7+
8+
- type: markdown
9+
attributes:
10+
value: Thanks for taking the time to fill out this bug report 🙏 !
11+
12+
- type: checkboxes
13+
attributes:
14+
label: ✅ Code of conduct checklist
15+
description: >
16+
Before submitting a bug, please make sure you went through the following
17+
steps.
18+
options:
19+
- label: "🌱 I am using the **_latest version_** of the [code](https://github.com/drprojects/point_geometric_features/tree/master)."
20+
required: true
21+
- label: "👩‍💻 I made sure the bug concerns the official [project's codebase](https://github.com/drprojects/point_geometric_features/tree/master) and not something I coded myself on top of it. (We only provide support for code we wrote and released ourselves)."
22+
required: true
23+
- label: "🔎 I took appropriate **_time_** to investigate the problem before filing an issue, but am unable to solve it myself."
24+
required: true
25+
- label: "📙 I **_thoroughly_** went through the [README](https://github.com/drprojects/point_geometric_features/blob/master/README.md), but could not find the solution there."
26+
required: true
27+
- label: "📜 I went through the **_docstrings_** and **_comments_** in the [source code](https://github.com/drprojects/point_geometric_features/tree/master) parts relevant to my problem, but could not find the solution there."
28+
required: true
29+
- label: "👩‍🔧 I searched for [**_similar issues_**](https://github.com/drprojects/point_geometric_features/issues), but could not find the solution there."
30+
required: true
31+
- label: "🔎 I made sure my bug is related to the [project's codebase](https://github.com/drprojects/point_geometric_features/tree/master) and is not in fact a sub-dependency issue."
32+
required: true
33+
- label: "⭐ Since I am showing interest in the project, I took the time to give the [repo](https://github.com/drprojects/point_geometric_features/tree/master) a ⭐ to show support. **Please do, it means a lot to us !**"
34+
required: true
35+
36+
- type: textarea
37+
attributes:
38+
label: 🐛 Describe the bug
39+
description: >
40+
Please provide a _**clear and concise**_ description of the issue you
41+
are facing. If the code does not behave as anticipated, please describe
42+
the expected behavior. Include references to any relevant documentation
43+
or related issues.
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
id: logs
49+
attributes:
50+
label: 📜 Log output
51+
description: >
52+
If relevant, please copy and paste any useful log output. If copying an
53+
error message, make sure you provide the _**full traceback**_. This will
54+
be automatically rendered as shell code, so no need for backticks.
55+
placeholder: |
56+
<< Full error message >>
57+
render: shell
58+
59+
- type: textarea
60+
attributes:
61+
label: 🤖 Steps to reproduce the bug
62+
description: >
63+
Please provide a _**minimal reproducible example**_ to help us
64+
investigate the bug.
65+
placeholder: |
66+
A step-by-step recipe for reproducing your bug. Use backticks as shown
67+
below to write and render code snippets.
68+
69+
```python
70+
# Some python code to reproduce the problem
71+
```
72+
73+
```
74+
Some error message you got, with the full traceback.
75+
```
76+
validations:
77+
required: true
78+
79+
- type: textarea
80+
attributes:
81+
label: 📚 Additional information
82+
description: >
83+
Please add any additional information that could help us diagnose the
84+
problem better. Provide screenshots if applicable. You may attach
85+
log files, generated wheel, or any other file that could be helpful.
86+
87+
- type: textarea
88+
attributes:
89+
label: 🖥️ Environment
90+
description: |
91+
Please run the following and paste the output here. This will let us know more about your environment.
92+
```sh
93+
curl -OL https://raw.githubusercontent.com/pytorch/pytorch/main/torch/utils/collect_env.py
94+
# For security purposes, please check the contents of collect_env.py before running it.
95+
python3 collect_env.py
96+
```
97+
render: shell
98+
placeholder: |
99+
<< Copy the output of `collect_env.py` here >>
100+
validations:
101+
required: true

‎.github/ISSUE_TEMPLATE/1-feature-request.yaml

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: "🚀 Feature Request"
2+
description: Propose a new feature
3+
title: Title of your feature request
4+
labels: ["feature"]
5+
6+
body:
7+
8+
- type: markdown
9+
attributes:
10+
value: Thanks for taking the time to fill out this feature request report 🙏 !
11+
12+
- type: checkboxes
13+
attributes:
14+
label: ✅ Code of conduct checklist
15+
description: >
16+
Before submitting a feature request, please make sure you went through
17+
the following steps.
18+
options:
19+
- label: "🌱 I am using the **_latest version_** of the [code](https://github.com/drprojects/point_geometric_features/tree/master)."
20+
required: true
21+
- label: "📙 I **_thoroughly_** went through the [README](https://github.com/drprojects/point_geometric_features/blob/master/README.md), but could not find the feature I need there."
22+
required: true
23+
- label: "📜 I went through the **_docstrings_** and **_comments_** in the [source code](https://github.com/drprojects/point_geometric_features/tree/master) parts relevant to my problem, but could not find the feature I need there."
24+
required: true
25+
- label: "👩‍🔧 I searched for [**_similar issues_**](https://github.com/drprojects/point_geometric_features/issues), but could not find the feature I need there."
26+
required: true
27+
- label: "⭐ Since I am showing interest in the project, I took the time to give the [repo](https://github.com/drprojects/point_geometric_features/tree/master) a ⭐ to show support. **Please do, it means a lot to us !**"
28+
required: true
29+
30+
- type: textarea
31+
attributes:
32+
label: 🚀 The feature, motivation and pitch
33+
description: >
34+
A clear and concise description of the feature proposal. Please outline
35+
the motivation for the proposal. Is your feature request related to a
36+
specific problem ? e.g., *"I'm working on X and would like Y to be
37+
possible"*. If this is related to another GitHub issue, please link here
38+
too.
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
attributes:
44+
label: 🔀 Alternatives
45+
description: >
46+
A description of any alternative solutions or features you've
47+
considered, if any.
48+
49+
- type: textarea
50+
attributes:
51+
label: 📚 Additional context
52+
description: >
53+
Add any other context or screenshots about the feature request.

‎.github/ISSUE_TEMPLATE/2-documentation.yaml

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: "📚 Typos and Documentation Fixes"
2+
description: Tell us about how we can improve our documentation
3+
title: Title of your documentation/typo fix/request
4+
labels: ["documentation"]
5+
6+
body:
7+
8+
- type: markdown
9+
attributes:
10+
value: Thanks for taking the time to fill out this documentation report 🙏 !
11+
12+
- type: checkboxes
13+
attributes:
14+
label: ✅ Code of conduct checklist
15+
description: >
16+
Before submitting a bug, please make sure you went through the following
17+
steps.
18+
options:
19+
- label: "🌱 I am using the **_latest version_** of the [code](https://github.com/drprojects/point_geometric_features/tree/master)."
20+
required: true
21+
- label: "📙 I went through the [README](https://github.com/drprojects/point_geometric_features/blob/master/README.md), but could not find the appropriate documentation there."
22+
required: true
23+
- label: "📜 I went through the **_docstrings_** and **_comments_** in the [source code](https://github.com/drprojects/point_geometric_features/tree/master) parts relevant to my problem, but could not find the appropriate documentation there."
24+
required: true
25+
- label: "👩‍🔧 I searched for [**_similar issues_**](https://github.com/drprojects/point_geometric_features/issues), but could not find the appropriate documentation there."
26+
required: true
27+
- label: "⭐ Since I am showing interest in the project, I took the time to give the [repo](https://github.com/drprojects/point_geometric_features/tree/master) a ⭐ to show support. **Please do, it means a lot to us !**"
28+
required: true
29+
30+
- type: textarea
31+
attributes:
32+
label: 📚 Describe the documentation issue
33+
description: |
34+
A clear and concise description of the issue.
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
attributes:
40+
label: Suggest a potential alternative/fix
41+
description: |
42+
Tell us how we could improve the documentation in this regard.

‎.github/ISSUE_TEMPLATE/3-refactor.yaml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: "🛠 Refactor"
2+
description: Suggest a code refactor or deprecation
3+
title: Title of your refactor/deprecation report
4+
labels: refactor
5+
6+
body:
7+
8+
- type: markdown
9+
attributes:
10+
value: Thanks for taking the time to fill out this refactor report 🙏 !
11+
12+
- type: textarea
13+
attributes:
14+
label: 🛠 Proposed Refactor
15+
description: |
16+
A clear and concise description of the refactor proposal. Please outline
17+
the motivation for the proposal. If this is related to another GitHub
18+
issue, please link here too.
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
attributes:
24+
label: Suggest a potential alternative/fix
25+
description: |
26+
Tell us how we could improve the code in this regard.
27+
validations:
28+
required: true

‎.github/ISSUE_TEMPLATE/config.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

0 commit comments

Comments
 (0)