From 4b3e108f99f8c451e6717af65612e4f87e17d696 Mon Sep 17 00:00:00 2001 From: Jacky Song <61605733+Songtech-0912@users.noreply.github.com> Date: Wed, 14 Jul 2021 18:57:01 -0400 Subject: [PATCH] Update contributor templates [2] (#652) * Update pull request template * Add issue tracker dashboard * Update issue templates as 2 separate templates * Wording fixes in feature.yml * Content fixes in bug.yml * Added placeholder to system info section of form * Removed unnecessary units and duplicate information in sysinfo placeholder --- .github/ISSUE_TEMPLATE/bug.yml | 123 +++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 18 +++++ .github/ISSUE_TEMPLATE/feature.yml | 51 ++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 35 +++++++- 4 files changed, 223 insertions(+), 4 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000000..4bcac40fdc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,123 @@ +name: New issue for bug report +description: Got a glitch, crash, or some other problem? If you're sure your issue is reproducible, feel free to report the issue to Natron's development team. +title: "(Bug): " +labels: "type:bug" +body: + # Greeter message + - type: markdown + attributes: + value: | + Thank you for reporting a bug! Please first check the boxes below to ensure that your bug report meets our requirements. + # Requirements checks + - type: checkboxes + attributes: + options: + - label: I'm using the latest version of Natron (not required but recommended) + - label: I've restarted Natron and the issue persists + required: true + - label: I've run Natron via the [command line](https://natron.readthedocs.io/en/rb-2.4/devel/natronexecution.html) and the issue persists + required: true + - label: I've followed the [contributing guidelines](https://github.com/NatronGitHub/Natron/blob/RB-2.4/CONTRIBUTING.md) to the best of my understanding + required: true + - label: My issue is not on the [issue tracker](https://github.com/NatronGitHub/Natron/issues?q=is%3Aissue+type%3Abug) and is not a duplicate of a forum thread + required: true + - label: This bug is reproducible + required: true + - label: This issue is not a feature request or a pull request + required: true + # Natron & OS versions + - type: input + id: natron-version + attributes: + label: Natron version + description: Natron version/commit (they can be retrieved from the about window or with `natron --about`) + placeholder: "Natron 2.4.0" + validations: + required: true + - type: input + id: os-version + attributes: + label: Operating system + description: The name and version of your operating system + placeholder: "macOS 10.15 Catalina" + validations: + required: true + # System (hardware) info + - type: textarea + attributes: + label: System specs + render: markdown + placeholder: | + RAM: 15.6 GB + CPU: Intel Core i7-7700HQ @ 2.80GHz + GPU: NVIDIA GeForce GTX 1070 + description: | + Please input the following (if you know them): + - Your system's RAM + - The model of your CPU(s) + - The model of your GPU(s) + validations: + required: false + # Did the user install via the official installer? + - type: checkboxes + attributes: + label: Did you install Natron using the official installer? + description: If you installed Natron via another method, please add your installation method in the \"additional details\" section at the bottom of this form + options: + - label: Yes, I used the official installer + - label: No, I installed from a binary archive + - label: No, I compiled Natron from sources + - label: No, I installed Natron via another method + validations: + required: true + # At which location did the user install Natron? + - type: textarea + attributes: + label: If you installed to a custom (non-default) location please include it here: + placeholder: `/opt/Natron-2.4.0` + render: markdown + validations: + required: false + # What was the user trying to do? + - type: textarea + attributes: + label: What were you trying to do? + placeholder: While working on a project in Natron I tried to... + render: markdown + validations: + required: true + # What did the user expect to happen? What was the actual behavior? + - type: textarea + attributes: + label: What did you expect to happen? What happened instead? + render: markdown + description: | + You may submit a link to any screenshots/videos that can be used to understand how to reproduce the issue. Additionally, depending on situation, you should also submit one of the following: + - If your problem can be reproduced using a Natron project, please include a link to the project on a file sharing service, or attach the project as a zip file to this issue, if possible. + - If your problem is a crash in an official release/snapshot, please include verbose output from the application from a terminal if possible. If you also submitted a crash report, indicate the Crash ID if possible. + - If you need to report a compilation issue, please create a [gist](https://gist.github.com) that contains the _full_ verbose build log. + - If your problem is a crash in a build that you made yourself, please create a [gist](https://gist.github.com) that contains a _full_ backtrace. + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: true + # Step-by-step reproduction instructions + - type: textarea + attributes: + label: Step-by-step reproduction instructions + render: markdown + placeholder: | + 1. Start Natron... + 2. Open attached project... + 3. Run "..." + 4. See error... + validations: + required: true + # Additional details + - type: textarea + attributes: + label: Additional details + description: Add any other relevant information here + render: markdown + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..287f82ec6f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,18 @@ +# This file is a template generator for Natron's issue tracker dashboard + +# The blank template uses the old issue template +blank_issues_enabled: true + +contact_links: + - name: Read the Code of Conduct + url: https://github.com/NatronGitHub/Natron/blob/RB-2.4/CODE_OF_CONDUCT.md + about: Before creating any issue, please read Natron's code of conduct and follow it to the best of your understanding. + - name: Read the contributing guidelines + url: https://github.com/NatronGitHub/Natron/blob/RB-2.4/CONTRIBUTING.md + about: Not sure of how to contribute? Read the contributing guidelines to get started. + - name: View the troubleshooting docs + url: http://natron.readthedocs.io/en/rb-2.4/guide/getstarted-troubleshooting.html + about: You can find many easy solutions to common questions on the troubleshooting docs, without needing to create an issue! + - name: Get help on Natron's forum + url: https://discuss.pixls.us/c/software/natron/27 + about: Have a ("how do I...?") question? Not sure if your issue is reproducible? The quickest way to get help is on Natron's community forum! diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000000..9a4babc915 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,51 @@ +name: New issue for feature request +description: "Have a feature suggestion? Share your idea with a feature request." +title: "(Feature): <title>" +labels: "type: feature" +body: + # Greeter message + - type: markdown + attributes: + value: Thank you for suggesting a feature! Please first check the boxes below to ensure that your feature request meets our requirements. + # Requirements checks + - type: checkboxes + attributes: + options: + - label: I have read the [feature request guidelines](https://hackmd.io/@natron-dev-awesome/B1SW6Hbau) + required: true + - label: I have followed the [contributing guidelines](https://github.com/NatronGitHub/Natron/blob/RB-2.4/CONTRIBUTING.md) to the best of my understanding + required: true + - label: This feature is not on the [issue tracker](https://github.com/NatronGitHub/Natron/issues?q=is%3Abug+type%3Afeature+type%3Aidea) and is not a duplicate + required: true + # Feature request description + - type: textarea + attributes: + label: Provide a description of your feature request + render: markdown + validations: + required: true + # Realistically implementable or not? + - type: checkboxes + attributes: + label: Is this a realistically implementable feature? + description: | + A feature is realistically implementable if you can reasonably expect yourself to implement the feature within 1 month of the request. A feature can still be added if it is not realistically implementable, but it will be tagged as an *idea* and relegated to be added in the indefinite future. + options: + - label: My feature is realistically implementable + - label: My feature is NOT realistically implementable + # Contributable or not? + - type: checkboxes + attributes: + label: Can you contribute in creating this feature? + options: + - label: I am unable, or not willing to contribute to creating this feature + - label: I am able and willing to contribute to the creation of this feature + # Additional details + - type: textarea + attributes: + label: Additional details + description: | + You do not have to fill this out but more details are always helpful! + render: markdown + validations: + required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ba23009a65..8ea2452187 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,33 @@ -Please read the [contribution guidelines](https://github.com/NatronGitHub/Natron/blob/master/CONTRIBUTING.md). +Thanks for submitting a pull request! Please provide enough information so that others can review your pull request. Additionally, make sure you've done all of these things: -## Description +- [ ] I've followed the [contributing guidelines](https://github.com/NatronGitHub/Natron/blob/RB-2.4/CODE_OF_CONDUCT.md) to the best of my understanding +- [ ] I've read and understood the [contributing guidelines](https://github.com/NatronGitHub/Natron/blob/RB-2.4/CONTRIBUTING.md) +- [ ] I've formatted my code according to Natron's [code style]([#](https://github.com/NatronGitHub/Natron#logistics)) +- [ ] I've searched the [pull requests tracker](https://github.com/NatronGitHub/Natron/pulls?q=is%3Apr) to ensure that this PR is not a duplicate -Please provide a description of what this PR is meant to fix, -and how it works (if it's not going to be very clear from the code). +## PR Description + +**What type of PR is this? (Check one of the boxes below)** + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Improvement (non-breaking change which does not add functionality nor fixes a bug but improves Natron in some way) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) +- [ ] My change requires a change to the documentation + - [ ] I have updated the documentation accordingly + +**What does this pull request do?** + +[Your answer, explain the motivation for making this change.] + +**Show a few screenshots (if this is a visual change)** + +[Your answer, delete this section if it is not a visual change.] + +**Have you tested your changes (if applicable)? If so, how?** + +[Your answer] + +**Futher details of this pull request** + +[Your answer]