-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add templates for creating issues and PRs
- Loading branch information
1 parent
62ee079
commit e167773
Showing
4 changed files
with
174 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
blank_issues_enabled: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
**Issue #[IssueNo]** | ||
|
||
## Motivation | ||
|
||
<!-- This can usually be copied from the issue. Please do not just say, go see issue but instead copy the relevant details here. --> | ||
|
||
## 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. |