From 1e1e895027aa1723968ef707d367ff5c65e048b1 Mon Sep 17 00:00:00 2001 From: Michael Grupp Date: Wed, 7 Oct 2020 12:56:54 +0200 Subject: [PATCH] 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 --- .github/ISSUE_TEMPLATE | 25 --------------------- .github/ISSUE_TEMPLATE/bug-report.md | 19 ++++++++++++++++ .github/ISSUE_TEMPLATE/general-issue.md | 5 +++++ .github/ISSUE_TEMPLATE/tuning-advice.md | 30 +++++++++++++++++++++++++ 4 files changed, 54 insertions(+), 25 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/general-issue.md create mode 100644 .github/ISSUE_TEMPLATE/tuning-advice.md diff --git a/.github/ISSUE_TEMPLATE b/.github/ISSUE_TEMPLATE deleted file mode 100644 index 1966427..0000000 --- a/.github/ISSUE_TEMPLATE +++ /dev/null @@ -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 - -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. diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 0000000..b1d8c54 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -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 `): + +- 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. diff --git a/.github/ISSUE_TEMPLATE/general-issue.md b/.github/ISSUE_TEMPLATE/general-issue.md new file mode 100644 index 0000000..24180eb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general-issue.md @@ -0,0 +1,5 @@ +--- +name: General issue +about: Use this issue for general questions. + +--- diff --git a/.github/ISSUE_TEMPLATE/tuning-advice.md b/.github/ISSUE_TEMPLATE/tuning-advice.md new file mode 100644 index 0000000..48442f6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/tuning-advice.md @@ -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 + +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.