From a3e2d02b98ebae30bec8694a29bf4c48e9107a07 Mon Sep 17 00:00:00 2001 From: Crisgarner <@crisgarner> Date: Tue, 7 Jan 2025 17:49:59 -0600 Subject: [PATCH] chore: updated pr template --- .github/ISSUE_TEMPLATE/bug_report.md | 43 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++ .github/pull_request_template.md | 19 ++++++++++ 3 files changed, 82 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.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..074c6d75 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,43 @@ +--- +name: Bug report +about: Report a bug in MACI Platform +--- + +# Prerequisites + +Please answer the following questions for yourself before submitting an issue. + +- [ ] I am not running a deprecated version +- [ ] I checked the documentation and found no answer +- [ ] I checked to make sure that this issue has not already been filed + +# Expected Behavior + +Please describe the behavior you are expecting + +# Current Behavior + +What is the current behavior? + +# Failure Information + +Please help provide information about the failure if this is a bug. If it is not a bug, please remove the rest of this template. + +## Steps to Reproduce + +Please provide detailed steps for reproducing the issue. + +1. step 1 +2. step 2 +3. you get it... + +## Context + +Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions. + +- MACI Platform version: +- MACI version: + +## Failure Logs + +Please include any relevant log snippets or files here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..1d431fe4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for MACI Platform +--- + +# Prerequisites + +Please answer the following question for yourself before submitting a feature request. + +- [ ] I checked to make sure that this request has not already been filed + +# Motivation + +Is your feature request related to a specific problem? Is it just a crazy idea? Tell us about it! + +# Details + +Please describe your feature request in detail. + +Make sure that you have reviewed [MACI's Contributor Guidelines](https://maci.pse.dev/docs/contributing) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..385bb214 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,19 @@ +# Description + + + +## Additional Notes + + + +## Related issue(s) + + + +## Confirmation + +> [!IMPORTANT] +> We do not accept minor grammatical fixes (e.g., correcting typos, rewording sentences) unless they significantly improve clarity in technical documentation. These contributions, while appreciated, are not a priority for merging. If there is a grammatical error feel free to message the team. + +- [ ] I have read and understand MACI's [contributor guidelines](https://maci.pse.dev/docs/contributing) and [code of conduct](https://maci.pse.dev/docs/contributing/code-of-conduct). +- [ ] I run and verified that all tests pass acording to MACI's [testing guide](https://maci.pse.dev/docs/guides/testing).