From 83cb103c6e6afcef0f2fb3f067ea789ad16f6fd8 Mon Sep 17 00:00:00 2001 From: F-G Fernandez <26927750+frgfm@users.noreply.github.com> Date: Sun, 7 Aug 2022 11:31:14 +0200 Subject: [PATCH] ci: Updated issue templates and env collection script (#113) * ci: Removed unused variable from env collection script * ci: Updated GH issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 54 ------------------ .github/ISSUE_TEMPLATE/bug_report.yml | 64 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/feature_request.md | 27 --------- .github/ISSUE_TEMPLATE/feature_request.yml | 34 ++++++++++++ .github/collect_env.py | 6 -- 6 files changed, 103 insertions(+), 87 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 366684e9..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -## 🐛 Bug - - - -## To Reproduce - -Steps to reproduce the behavior: - -1. -2. -3. - - - -## Expected behavior - - - -## Environment - -Please copy and paste the output from our -[environment collection script](https://raw.githubusercontent.com/pyronear/pyro-engine/main/.github/collect_env.py) -(or fill out the checklist below manually). - -You can get the script and run it with: -``` -wget https://raw.githubusercontent.com/pyronear/pyro-engine/main/.github/collect_env.py -# For security purposes, please check the contents of collect_env.py before running it. -python collect_env.py -``` - - - pyroengine Version (e.g., 1.0.0): - - PyTorch Version (e.g., 1.2): - - Torchvision Version (e.g., 0.4): - - OS (e.g., Linux): - - How you installed pyroengine (`conda`, `pip`, source): - - Python version: - - CUDA/cuDNN version: - - GPU models and configuration: - - Any other relevant information: - - -## Additional context - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..8190a079 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,64 @@ +name: 🐛 Bug report +description: Create a report to help us improve the library +labels: 'type: bug' +assignees: + +body: +- type: markdown + attributes: + value: > + #### Before reporting a bug, please check that the issue hasn't already been addressed in [the existing and past issues](https://github.com/pyronear/pyro-ENGINE/issues?q=is%3Aissue). +- type: textarea + attributes: + label: Bug description + description: | + A clear and concise description of what the bug is. + + Please explain the result you observed and the behavior you were expecting. + placeholder: | + A clear and concise description of what the bug is. + validations: + required: true + +- type: textarea + attributes: + label: Code snippet to reproduce the bug + description: | + Sample code to reproduce the problem. + + Please wrap your code snippet with ```` ```triple quotes blocks``` ```` for readability. + placeholder: | + ```python + Sample code to reproduce the problem + ``` + validations: + required: true +- type: textarea + attributes: + label: Error traceback + description: | + The error message you received running the code snippet, with the full traceback. + + Please wrap your error message with ```` ```triple quotes blocks``` ```` for readability. + placeholder: | + ``` + The error message you got, with the full traceback. + ``` + validations: + required: true +- type: textarea + attributes: + label: Environment + description: | + Please run the following command and paste the output below. + ```sh + wget https://raw.githubusercontent.com/pyronear/pyro-engine/main/.github/collect_env.py + # For security purposes, please check the contents of collect_env.py before running it. + python collect_env.py + ``` + validations: + required: true +- type: markdown + attributes: + value: > + Thanks for helping us improve the library! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..f2e451e9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Usage questions + url: https://github.com/pyronear/pyro-ENGINE/discussions + about: Ask questions and discuss with other Pyronear community members diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index f488bd95..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -## 🚀 Feature - - -## Motivation - - - -## Pitch - - - -## Alternatives - - - -## Additional context - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..ea57fb70 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,34 @@ +name: 🚀 Feature request +description: Submit a proposal/request for a new feature for pyroengine +labels: 'type: new feature' +assignees: + +body: +- type: textarea + attributes: + label: 🚀 Feature + description: > + A clear and concise description of the feature proposal + validations: + required: true +- type: textarea + attributes: + label: Motivation & pitch + description: > + Please outline the motivation for the proposal. Is your feature request related to a specific problem? e.g., *"I'm working on X and would like Y to be possible"*. If this is related to another GitHub issue, please link here too. + validations: + required: true +- type: textarea + attributes: + label: Alternatives + description: > + A description of any alternative solutions or features you've considered, if any. +- type: textarea + attributes: + label: Additional context + description: > + Add any other context or screenshots about the feature request. +- type: markdown + attributes: + value: > + Thanks for contributing 🎉 \ No newline at end of file diff --git a/.github/collect_env.py b/.github/collect_env.py index 16662758..87601fc1 100644 --- a/.github/collect_env.py +++ b/.github/collect_env.py @@ -182,12 +182,6 @@ def replace_bools(dct, true="Yes", false="No"): dct[key] = false return dct - def maybe_start_on_next_line(string): - # If `string` is multiline, prepend a \n to it. - if string is not None and len(string.split("\n")) > 1: - return "\n{}\n".format(string) - return string - mutable_dict = envinfo._asdict() # Replace True with Yes, False with No