Use distinct issue templates for bugs, tuning and general things. (#1521)
This uses the more modern issue template mechanism of GitHub. Users will be able to choose one of these after clicking "add issue". --- The template for tuning is reworded to reflect that tuning issues are not guaranteed to be handled by maintainers. Signed-off-by: Michael Grupp <grupp@magazino.eu>master
parent
26ab581a20
commit
1e1e895027
|
@ -1,25 +0,0 @@
|
||||||
Thank you for filing an issue!
|
|
||||||
|
|
||||||
It would help us tremendously if you run through the following checklist. This
|
|
||||||
ensures that we have the most information to quickly understand, analyze,
|
|
||||||
reproduce and eventually resolve your issue.
|
|
||||||
|
|
||||||
Please
|
|
||||||
|
|
||||||
1. run `rosbag_validate` which does some checks on your sensor data. This
|
|
||||||
tool often finds issues that can explain poor performance and must be fixed
|
|
||||||
at recording time. Please post the full output of the tool into a
|
|
||||||
GitHub Gist at https://gist.github.com/, then link it in the issue even if
|
|
||||||
it does not report anything. You can run the tool like this:
|
|
||||||
|
|
||||||
rosrun cartographer_ros cartographer_rosbag_validate -bag_filename <bag filename>
|
|
||||||
|
|
||||||
2. post a link to a Git repository containing a branch of
|
|
||||||
`cartographer_ros` containing all the configuration, launch, and URDF files
|
|
||||||
required to reproduce your issue.
|
|
||||||
3. post a link to a bag file we can use to reproduce your issue. Put it on
|
|
||||||
Google Drive, Dropbox, any webserver or wherever it is publicly
|
|
||||||
downloadable.
|
|
||||||
4. remove this boilerplate text before submitting your issue.
|
|
||||||
|
|
||||||
We will likely be unable to help you without all of these points addressed.
|
|
|
@ -0,0 +1,19 @@
|
||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: Report a bug that you've found in this repository or in a release.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Please provide information for your bug report:
|
||||||
|
|
||||||
|
- if you're using cartographer_ros from source, provide the Git commit hash
|
||||||
|
(via `git log -1 --format="%H"`):
|
||||||
|
|
||||||
|
- if you're using a release package, provide the version
|
||||||
|
(e.g. via `apt show <package_name>`):
|
||||||
|
|
||||||
|
- provide all information that is needed to analyze and reproduce the bug
|
||||||
|
(logs, commands that have been used, ...)
|
||||||
|
|
||||||
|
PLEASE NOTE: we don't support custom forks or extensions.
|
||||||
|
If you need tuning advice, you can open a tuning issue instead.
|
|
@ -0,0 +1,5 @@
|
||||||
|
---
|
||||||
|
name: General issue
|
||||||
|
about: Use this issue for general questions.
|
||||||
|
|
||||||
|
---
|
|
@ -0,0 +1,30 @@
|
||||||
|
---
|
||||||
|
name: Help request for tuning
|
||||||
|
about: Describe tuning problems with your custom Cartographer setup to request help from the community.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
To improve the chances that other Cartographer users can help you,
|
||||||
|
here are some guidelines for describing your tuning problem:
|
||||||
|
|
||||||
|
1. check the tuning guide on the documentation page and previous issues -
|
||||||
|
some problems might have been solved already by other people.
|
||||||
|
|
||||||
|
2. run `rosbag_validate` which does some checks on your sensor data. This
|
||||||
|
tool often finds issues that can explain poor performance and must be fixed
|
||||||
|
at recording time. Please post the full output of the tool into a
|
||||||
|
GitHub Gist at https://gist.github.com/, then link it in the issue even if
|
||||||
|
it does not report anything. You can run the tool like this:
|
||||||
|
|
||||||
|
rosrun cartographer_ros cartographer_rosbag_validate -bag_filename <bag filename>
|
||||||
|
|
||||||
|
3. post a link to a Git repository containing a branch of
|
||||||
|
`cartographer_ros` containing all the configuration, launch, and URDF files
|
||||||
|
required to reproduce your issue.
|
||||||
|
4. post a link to a bag file we can use to reproduce your issue. Put it on
|
||||||
|
Google Drive, Dropbox, any webserver or wherever it is publicly
|
||||||
|
downloadable.
|
||||||
|
5. remove this boilerplate text before submitting your issue.
|
||||||
|
|
||||||
|
PLEASE NOTE: tuning issues are not necessarily handled by the maintainers and
|
||||||
|
can be closed after a period of inactivity.
|
Loading…
Reference in New Issue