diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..ee37253 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,101 @@ +name: Bug Report +description: Report any unexpected behaviour so we can improve this module. +title: "[Bug] " +labels: ["bug - potential"] +body: + - type: dropdown + id: drupal-version + attributes: + label: Drupal Version + description: What version of Drupal did you experience this bug on? + options: + - 9.4 + - 9.5 + - 10.0 + - 10.1 + validations: + required: true + - type: dropdown + id: tripal-version + attributes: + label: Tripal Version + description: What version of Tripal was installed on this site? + options: + - 4.0.0-alpha1 + - 4.x dev (most recent commit) + validations: + required: true + - type: dropdown + id: module-version + attributes: + label: Module Version + description: What version of this module were you using? + options: + - 4.x dev (most recent commit) + validations: + required: true + - type: dropdown + id: os + attributes: + label: Site Operating System + description: What operating system is your site installed on + options: + - Debian Linux + - Redhat Linux + - Other Linux Distribution + - Intel Mac + - M1 Chip Mac + - Windows + validations: + required: true + - type: dropdown + id: install-method + attributes: + label: Installation Method + description: How was this module installed? + options: + - TripalDocker docker + - Docker image built from this module + - Composer + - Manual Download + validations: + required: true + - type: dropdown + id: browsers + attributes: + label: Browsers + description: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + - Other + - type: textarea + id: description + attributes: + label: Observations + placeholder: A clear and concise description of what the bug is. Please include screenshots wherever possible and copy error message text. + validations: + required: true + - type: textarea + id: expected-behaviour + attributes: + label: Expected Behaviour + placeholder: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Steps to Reproduce + placeholder: Indicate steps to reproduce this bug. Ideally this includes a detailed numbered list. + validations: + required: true + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell \ 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 0000000..ec4bb38 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/development_task.yml b/.github/ISSUE_TEMPLATE/development_task.yml new file mode 100644 index 0000000..68e05cc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/development_task.yml @@ -0,0 +1,41 @@ +name: Development Task +description: MODULE DEVELOPERS ONLY These issues describe development tasks for the module. +title: "G[groupNo].[issueNo] " +body: + - type: input + id: branch + attributes: + label: Branch + description: This is the name of the branch that development will occur in. You will need to edit this issue to add in the issue number. + value: g[groupNo].[issueNo]-[shortDescriptor] + - type: dropdown + id: group + attributes: + label: Groups + description: Select the relevant groups applying to this task. Also remember to select the labels mapping to these groups. + multiple: true + options: + - "Group 0 - General" + - "Group 1 - Content Types | Ontology | Fields" + - "Group 2 - Data Importing" + - "Group 3 - Search | Browse | Tools" + - "Group 4 - API | Services | Plugins" + - "Group 5 | Automated Testing | Performance" + - type: textarea + id: description + attributes: + label: Describe + placeholder: | + Describe the task fully here. This should include the following as applicable: + - description of the task to be carried out including goal/purpose + - link to Tripal 3 code + - if developing a service or plugin then describe what code will call it + validations: + required: true + - type: textarea + id: design + attributes: + label: Design + placeholder: Describe the class name and methods in detail here if applicable. For methods, think of writing the docblock now before writing any code. + validations: + required: true \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..5aabb22 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,31 @@ +**Issue #[IssueNo]** + +## Motivation + + + +## What does this PR do? +*Please describe each things this PR does. For example, a PR may 1) solve a specific bug, 2) create an auomated test to ensure it doesn't return.* + +1. +2. +3. + +## Testing + +### Automated Testing +*Please describe each automated test this PR creates and provide a list of the assertions it makes using casual language.* +*Do not just say things like "asserts the array is not empty" but rather say "Ensures that the return value of method X with these parameters is not an empty array".* + +ClassName->testSpecificBug: tests this specific bug +- +- +- + +### Manual Testing +*Describe in detail how someone should manually test this functionality.* +*Make sure to include whether they need to build a docker from scratch, create any records, etc.* + +1. +2. +3. \ No newline at end of file