diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..fca63cdf3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,67 @@ +name: Bug Report +description: Report a fault or bug in ODM. +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + First of all, thank you for taking the time to report an issue. + + Before you continue, make sure you are in the right place. Please open an issue only to report faults and bugs. For questions and discussion please open a topic on the [community forum](https://community.opendronemap.org/c/opendronemap). + - type: checkboxes + id: prechecks + attributes: + label: Before you open an issue + options: + - label: I have searched the [community forum](https://community.opendronemap.org/c/opendronemap) and could not find an answer to my problem. + required: true + - label: I have searched [existing issues](https://github.com/OpenDroneMap/ODM/issues) and this bug has not already been reported. + required: true + - type: dropdown + id: install-method + attributes: + label: How did you install ODM (Docker, installer, natively, ...)? + options: + - Docker + - Installer + - Natively + - Other + validations: + required: true + - type: textarea + id: problem + attributes: + label: What is the problem? + validations: + required: true + - type: textarea + id: expected + attributes: + label: What should be the expected behavior? + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: How can we reproduce this? What steps did you do to trigger the problem? + validations: + required: true + - type: input + id: dataset + attributes: + label: Link to dataset + description: | + If this is an issue with processing a dataset, YOU MUST include a copy of your dataset, uploaded somewhere we can download from (otherwise we cannot reproduce this). + placeholder: https://drive.google.com/... + validations: + required: true + - type: textarea + id: logs + attributes: + label: Task output log + description: | + Paste the full task output log below (run ODM with `--verbose` where possible). This will be automatically formatted into code, so no need for backticks. + render: shell + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..35a61027b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,42 @@ +name: Feature Request +description: Suggest a new feature or enhancement for ODM. +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for your interest in improving ODM! + + **Please start on the [community forum](https://community.opendronemap.org/c/opendronemap) first.** New features should be discussed there so other community members can weigh in on whether they want the same thing, and so a plan can be agreed on before any code is written. Issues opened without prior discussion may be closed and redirected to the forum. + - type: checkboxes + id: prechecks + attributes: + label: Before you open an issue + options: + - label: I have discussed this feature on the [community forum](https://community.opendronemap.org/c/opendronemap) and there is interest in it. + required: true + - label: I have searched [existing issues](https://github.com/OpenDroneMap/ODM/issues) and this feature has not already been requested. + required: true + - type: input + id: forum-link + attributes: + label: Link to forum discussion + description: Paste the URL of the forum topic where this feature was discussed. + placeholder: https://community.opendronemap.org/t/... + validations: + required: true + - type: textarea + id: description + attributes: + label: Describe the feature + description: What should ODM do that it doesn't do today? Why is it useful? + validations: + required: true + - type: textarea + id: plan + attributes: + label: Proposed plan + description: Outline the agreed-on approach from the forum discussion. Where possible, cite files and lines where changes should be made. + validations: + required: true diff --git a/.github/workflows/issue-triage.yml b/.github/workflows/issue-triage.yml deleted file mode 100644 index c279b0a81..000000000 --- a/.github/workflows/issue-triage.yml +++ /dev/null @@ -1,34 +0,0 @@ -name: Issue Triage -on: - issues: - types: - - opened -jobs: - issue_triage: - runs-on: ubuntu-latest - permissions: - issues: write - steps: - - uses: pierotofy/issuewhiz@v1 - with: - ghToken: ${{ secrets.GITHUB_TOKEN }} - openAI: ${{ secrets.OPENAI_TOKEN }} - model: gpt-4o-2024-08-06 - filter: | - - "#" - variables: | - - Q: "A question about using a software or seeking guidance on doing something?" - - B: "Reporting an issue or a software bug?" - - P: "Describes an issue with processing a set of images or a particular dataset?" - - D: "Contains a link to a dataset or images?" - - E: "Contains a suggestion for an improvement or a feature request?" - - SC: "Describes an issue related to compiling or building source code?" - logic: | - - 'Q and (not B) and (not P) and (not E) and (not SC) and not (title_lowercase ~= ".*bug: .+")': [comment: "Could we move this conversation over to the forum at https://community.opendronemap.org? The forum is the right place to ask questions (we try to keep the GitHub issue tracker for feature requests and bugs only). Thank you!", close: true, stop: true] - - "B and (not P) and (not E) and (not SC)": [label: "software fault", stop: true] - - "P and D": [label: "possible software fault", stop: true] - - "P and (not D) and (not SC) and (not E)": [comment: "Thanks for the report, but it looks like you didn't include a copy of your dataset for us to reproduce this issue? Please make sure to follow our [issue guidelines](https://github.com/OpenDroneMap/ODM/blob/master/docs/issue_template.md) :pray: ", close: true, stop: true] - - "E": [label: enhancement, stop: true] - - "SC": [label: "possible software fault"] - - signature: "p.s. I'm just an automated script, not a human being." diff --git a/docs/issue_template.md b/docs/issue_template.md deleted file mode 100644 index f873a132f..000000000 --- a/docs/issue_template.md +++ /dev/null @@ -1,26 +0,0 @@ -**************************************** -PLEASE REMOVE THIS NOTE AFTER READING IT! - -First of all, thank you for taking the time to report an issue. - -Before you continue, make sure you are in the right place. Please open an issue only to report faults and bugs. For questions and discussion please open a topic on http://community.opendronemap.org/c/opendronemap. - -Please use the format below to report bugs and faults. -**************************************** - -### How did you install ODM? (Docker, installer, natively, ...)? - -[Type answer here] - -### What is the problem? - -[Type answer here] - -### What should be the expected behavior? If this is a feature request, please describe in detail the changes you think should be made to the code, citing files and lines where changes should be made, if possible. - -[Type answer here] - -### How can we reproduce this? What steps did you do to trigger the problem? If this is an issue with processing a dataset, YOU MUST include a copy of your dataset AND task output log, uploaded on Google Drive or Dropbox (otherwise we cannot reproduce this). - -[Type answer here] -