diff --git a/.github/ISSUE_TEMPLATES/BASIC_ISSUE_FORM.yml b/.github/ISSUE_TEMPLATES/BASIC_ISSUE_FORM.yml new file mode 100644 index 0000000000..184699ca0d --- /dev/null +++ b/.github/ISSUE_TEMPLATES/BASIC_ISSUE_FORM.yml @@ -0,0 +1,77 @@ +name: Internal - Basic Issue +description: Create an internal HotShot issue +title: "[] - Short Task Description " +labels: ["sprint6"] +projects: ["EspressoSystems/20", "EspressoSystems/32"] +body: + - type: markdown + attributes: + value: | + *If you are an external collaborator use our external issue form instead.* + - type: textarea + id: task_reason + attributes: + label: What is this task and why do we need to work on it? + placeholder: | + For MACRO tasks: The description should be written for someone unfamiliar with HotShot. + For regular tasks: The description should be written for someone familiar with HotShot but not with this particular issue. + validations: + required: true + - type: textarea + id: task_description + attributes: + label: What work will need to be done to complete this task? + description: + placeholder: | + If this is unknown, describe what information is needed to determine this. + + If this is a MACRO task link the sub-issues here. + If this is a regular task use check boxes to list the sub-tasks here. + + E.g. + - [ ] Task 1 + - [ ] Task 2 + validations: + required: false + - type: textarea + id: other_details + attributes: + label: Are there any other details to include? + placeholder: | + Include other details here such as: design tradeoffs, open questions, links to discussions about this issue, dependencies of this task, etc. + validations: + required: false + + - type: textarea + id: acceptance_criteria + attributes: + label: What are the acceptance criteria to close this issue? + placeholder: | + Include a list of acceptance criteria such as: required reviewers, new tests that must be added, documentation that must be added, etc. + validations: + required: true + + - type: markdown + attributes: + value: | + ### Complete the following items before submitting this issue: + * Label this issue appropriately. All issues must have a `sprint` label unless they are labeled `external`, `low-priority`, or `tech-debt`. This form will automatically label issues with our current `sprint` label. + * Ensure this issue is added to the appropriate projects. This form should add them to the "HotShot" and "Espresso Sequencer" projects by default. + * Ensure this issue is titled correctly. + * For MACRO tasks, title the issue [MACRO] - - Macro Task Short Description + * E.g. [MACRO] - VIEW_SYNC - Add NK20 View Sync algorithm + * For non-MACRO tasks, title the issue [] - Task Short Description + * E.g. [VIEW_SYNC] - Create new vote types for `PreCommit`, `Commit`, and `Finalize` view sync votes + * Ensure MACRO tasks have all their sub-issues linked + * Ensure non-MACRO tasks have their associated MACRO task linked + * Assign this issue to the appropriate person, if applicable + + ### Other considerations: + * All non-macro tasks must link to a MACRO task unless the task falls into one of the following categories. Use these categories in lieu of a MACRO_TASK_SHORT_NAME. + * TECH_DEBT - Label for tech debt + * CI - Label for CI-related issues + * REPO - Label for repository organization issues (such as updating these template files) + * DOCS - Label for issues related to documentation + * If a non-MACRO task has linked sub-issues, consider converting it into a MACRO task. Non-macro tasks should be small enough in scope that they do not contain sub-issues. They may contain sub-tasks, however. + + diff --git a/.github/ISSUE_TEMPLATES/EXTERNAL_ISSUE.yml b/.github/ISSUE_TEMPLATES/EXTERNAL_ISSUE.yml new file mode 100644 index 0000000000..99f6adfc4d --- /dev/null +++ b/.github/ISSUE_TEMPLATES/EXTERNAL_ISSUE.yml @@ -0,0 +1,41 @@ +name: External - Basic Issue +description: Create an external HotShot issue +title: "[EXTERNAL] - " +labels: ["external"] +assignees: ["elliedavidson"] +body: + - type: markdown + attributes: + value: | + *If you are an internal collaborator, use our internal issue form instead* + - type: textarea + id: task_reason + attributes: + label: What is this task and why do we need to work on it? + placeholder: | + If this is a feature request, describe what the feature is and why it is important to add to HotShot. + If this is a bug report, describe the bug and its severity level. + validations: + required: true + - type: textarea + id: other_details + attributes: + label: Are there any other details to include? + placeholder: | + Include other details here such as: open questions, directions to reproduce a bug, relevant error logs, etc. + + E.g. To reproduce this bug run `just async_std test_basic`. You should see logs similar to the below: + `ERROR: This is an important error!` + validations: + required: false + + - type: markdown + attributes: + value: | + ### Complete the following items before submitting this issue: + * Label this issue appropriately. This form will automatically label issues with the `external` label. If you are submitting a bug report, please also add the `bug` label. + * Ensure this issue is titled correctly. The title should be in the form of [EXTERNAL] - Short task description. + + Thank you for submitting an issue to HotShot! + + diff --git a/pull_request_template.md b/pull_request_template.md new file mode 100644 index 0000000000..aaee71fa74 --- /dev/null +++ b/pull_request_template.md @@ -0,0 +1,24 @@ +Closes issue: + +### This PR: + + + + + + +### This PR does not: + + + +### Key places to review: + + + +### How to test this PR: + + +