From 10c94e781450c3bff94db09f2470e7e304fc62d2 Mon Sep 17 00:00:00 2001 From: Matthew Lam Date: Mon, 28 Aug 2023 20:08:54 +0000 Subject: [PATCH] adding issue and pull request templates --- .github/ISSUE_TEMPLATE/bug_report.md | 31 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_spec.md | 19 ++++++++++++++++ .github/pull_request_template.md | 7 ++++++ 3 files changed, 57 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_spec.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..3c6e9557 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,31 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Logs** +If applicable, please include the relevant logs that indicate a problem. + +**Operating System** +Which OS you used to reveal the bug. + +**Additional context** +Add any other context about the problem here. + +**To best protect the Avalanche community security bugs should be reported in accordance to our [Security Policy](../../SECURITY.md)** diff --git a/.github/ISSUE_TEMPLATE/feature_spec.md b/.github/ISSUE_TEMPLATE/feature_spec.md new file mode 100644 index 00000000..f270ff03 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_spec.md @@ -0,0 +1,19 @@ +--- +name: Feature specification +about: Discussion on design and implementation of new features for awm-relayer. +title: '' +labels: enhancement +assignees: '' + +--- + +**Context and scope** +Include a short description of the context and scope of the suggested feature. +Include goals the change will accomplish if relevant. + +**Discussion and alternatives** +Include a description of the changes to be made to the code along with alternatives +that were considered, including pro/con analysis where relevant. + +**Open questions** +Questions that are still being discussed. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..7ff1a9ef --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,7 @@ +## Why this should be merged + +## How this works + +## How this was tested + +## How is this documented \ No newline at end of file