|
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/superpoint_transformer/tree/master)." |
20 | | - required: true |
21 | | - - label: "👩💻 I made sure the bug concerns the official [project's codebase](https://github.com/drprojects/superpoint_transformer/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/superpoint_transformer/blob/master/README.md), but could not find the solution there." |
26 | | - required: true |
27 | | - - label: "📘 I **_thoroughly_** went through the tutorial [slides](media/superpoint_transformer_tutorial.pdf), [notebook](notebooks/superpoint_transformer_tutorial.ipynb), and [video](https://www.youtube.com/watch?v=2qKhpQs9gJw), but could not find the solution there." |
28 | | - required: true |
29 | | - - label: "📗 I **_thoroughly_** went through the [documentation](https://github.com/drprojects/superpoint_transformer/tree/master/docs), but could not find the solution there." |
30 | | - required: true |
31 | | - - label: "📜 I went through the **_docstrings_** and **_comments_** in the [source code](https://github.com/drprojects/superpoint_transformer/tree/master) parts relevant to my problem, but could not find the solution there." |
32 | | - required: true |
33 | | - - label: "👩🔧 I searched for [**_similar issues_**](https://github.com/drprojects/superpoint_transformer/issues), but could not find the solution there." |
34 | | - required: true |
35 | | - - label: "🔎 I made sure my bug is related to the [project's codebase](https://github.com/drprojects/superpoint_transformer/tree/master) and is not in fact a sub-dependency issue (e.g.: FRNN installation issue, PyTorch installation issue, PyTorch Geometric not installed with GPU support, ...)." |
36 | | - required: true |
37 | | - - label: "⭐ Since I am showing interest in the project, I took the time to give the [repo](https://github.com/drprojects/superpoint_transformer/tree/master) a ⭐ to show support. **Please do, it means a lot to us !**" |
38 | | - required: true |
39 | | - |
40 | | - - type: textarea |
41 | | - attributes: |
42 | | - label: 🐛 Describe the bug |
43 | | - description: > |
44 | | - Please provide a _**clear and concise**_ description of the issue you |
45 | | - are facing. If the code does not behave as anticipated, please describe |
46 | | - the expected behavior. Include references to any relevant documentation |
47 | | - or related issues. |
48 | | - validations: |
49 | | - required: true |
50 | | - |
51 | | - - type: textarea |
52 | | - id: logs |
53 | | - attributes: |
54 | | - label: 📜 Log output |
55 | | - description: > |
56 | | - If relevant, please copy and paste any useful log output. If copying an |
57 | | - error message, make sure you provide the _**full traceback**_. This will |
58 | | - be automatically rendered as shell code, so no need for backticks. |
59 | | - placeholder: | |
60 | | - << Full error message >> |
61 | | - render: shell |
62 | | - |
63 | | - - type: textarea |
64 | | - attributes: |
65 | | - label: 🤖 Steps to reproduce the bug |
66 | | - description: > |
67 | | - Please provide a _**minimal reproducible example**_ to help us |
68 | | - investigate the bug. |
69 | | - placeholder: | |
70 | | - A step-by-step recipe for reproducing your bug. Use backticks as shown |
71 | | - below to write and render code snippets. |
72 | | -
|
73 | | - ```python |
74 | | - # Some python code to reproduce the problem |
75 | | - ``` |
76 | | -
|
77 | | - ``` |
78 | | - Some error message you got, with the full traceback. |
79 | | - ``` |
80 | | - validations: |
81 | | - required: true |
82 | | - |
83 | | - - type: textarea |
84 | | - attributes: |
85 | | - label: 📚 Additional information |
86 | | - description: > |
87 | | - Please add any additional information that could help us diagnose the |
88 | | - problem better. Provide screenshots if applicable. You may attach |
89 | | - log files, generated wheel, or any other file that could be helpful. |
90 | | -
|
91 | | - - type: textarea |
92 | | - attributes: |
93 | | - label: 🖥️ Environment |
94 | | - description: | |
95 | | - Please run the following and paste the output here. This will let us know more about your environment. |
96 | | - ```sh |
97 | | - curl -OL https://raw.githubusercontent.com/pytorch/pytorch/main/torch/utils/collect_env.py |
98 | | - # For security purposes, please check the contents of collect_env.py before running it. |
99 | | - python3 collect_env.py |
100 | | - ``` |
101 | | - render: shell |
102 | | - placeholder: | |
103 | | - << Copy the output of `collect_env.py` here >> |
104 | | - validations: |
105 | | - required: true |
| 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/superpoint_transformer/tree/master)." |
| 20 | + required: true |
| 21 | + - label: "👩💻 I made sure the bug concerns the official [project's codebase](https://github.com/drprojects/superpoint_transformer/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/superpoint_transformer/blob/master/README.md), but could not find the solution there." |
| 26 | + required: true |
| 27 | + - label: "📘 I **_thoroughly_** went through the tutorial [slides](media/superpoint_transformer_tutorial.pdf), [notebook](notebooks/superpoint_transformer_tutorial.ipynb), and [video](https://www.youtube.com/watch?v=2qKhpQs9gJw), but could not find the solution there." |
| 28 | + required: true |
| 29 | + - label: "📗 I **_thoroughly_** went through the [documentation](https://github.com/drprojects/superpoint_transformer/tree/master/docs), but could not find the solution there." |
| 30 | + required: true |
| 31 | + - label: "📜 I went through the **_docstrings_** and **_comments_** in the [source code](https://github.com/drprojects/superpoint_transformer/tree/master) parts relevant to my problem, but could not find the solution there." |
| 32 | + required: true |
| 33 | + - label: "👩🔧 I searched for [**_similar issues_**](https://github.com/drprojects/superpoint_transformer/issues), but could not find the solution there." |
| 34 | + required: true |
| 35 | + - label: "🔎 I made sure my bug is related to the [project's codebase](https://github.com/drprojects/superpoint_transformer/tree/master) and is not in fact a sub-dependency issue (e.g.: FRNN installation issue, PyTorch installation issue, PyTorch Geometric not installed with GPU support, ...)." |
| 36 | + required: true |
| 37 | + - label: "⭐ Since I am showing interest in the project, I took the time to give the [repo](https://github.com/drprojects/superpoint_transformer/tree/master) a ⭐ to show support. **Please do, it means a lot to us !**" |
| 38 | + required: true |
| 39 | + |
| 40 | + - type: textarea |
| 41 | + attributes: |
| 42 | + label: 🐛 Describe the bug |
| 43 | + description: > |
| 44 | + Please provide a _**clear and concise**_ description of the issue you |
| 45 | + are facing. If the code does not behave as anticipated, please describe |
| 46 | + the expected behavior. Include references to any relevant documentation |
| 47 | + or related issues. |
| 48 | + validations: |
| 49 | + required: true |
| 50 | + |
| 51 | + - type: textarea |
| 52 | + id: logs |
| 53 | + attributes: |
| 54 | + label: 📜 Log output |
| 55 | + description: > |
| 56 | + If relevant, please copy and paste any useful log output. If copying an |
| 57 | + error message, make sure you provide the _**full traceback**_. This will |
| 58 | + be automatically rendered as shell code, so no need for backticks. |
| 59 | + placeholder: | |
| 60 | + << Full error message >> |
| 61 | + render: shell |
| 62 | + |
| 63 | + - type: textarea |
| 64 | + attributes: |
| 65 | + label: 🤖 Steps to reproduce the bug |
| 66 | + description: > |
| 67 | + Please provide a _**minimal reproducible example**_ to help us |
| 68 | + investigate the bug. |
| 69 | + placeholder: | |
| 70 | + A step-by-step recipe for reproducing your bug. Use backticks as shown |
| 71 | + below to write and render code snippets. |
| 72 | +
|
| 73 | + ```python |
| 74 | + # Some python code to reproduce the problem |
| 75 | + ``` |
| 76 | +
|
| 77 | + ``` |
| 78 | + Some error message you got, with the full traceback. |
| 79 | + ``` |
| 80 | + validations: |
| 81 | + required: true |
| 82 | + |
| 83 | + - type: textarea |
| 84 | + attributes: |
| 85 | + label: 📚 Additional information |
| 86 | + description: > |
| 87 | + Please add any additional information that could help us diagnose the |
| 88 | + problem better. Provide screenshots if applicable. You may attach |
| 89 | + log files, generated wheel, or any other file that could be helpful. |
| 90 | +
|
| 91 | + - type: textarea |
| 92 | + attributes: |
| 93 | + label: 🖥️ Environment |
| 94 | + description: | |
| 95 | + Please run the following and paste the output here. This will let us know more about your environment. |
| 96 | + ```sh |
| 97 | + curl -OL https://raw.githubusercontent.com/pytorch/pytorch/main/torch/utils/collect_env.py |
| 98 | + # For security purposes, please check the contents of collect_env.py before running it. |
| 99 | + python3 collect_env.py |
| 100 | + ``` |
| 101 | + render: shell |
| 102 | + placeholder: | |
| 103 | + << Copy the output of `collect_env.py` here >> |
| 104 | + validations: |
| 105 | + required: true |
0 commit comments