From b3637b4a63722ef85d2273c8ac8da9a180f66ae6 Mon Sep 17 00:00:00 2001
From: Freddy Li <freddy@chainsafe.io>
Date: Mon, 8 Jan 2024 10:50:30 -0500
Subject: [PATCH] chore: add bug and issue template (#147)

Co-authored-by: Freddy Li <freddyli@Freddys-MacBook-Pro-16.local>
---
 .github/ISSUE_TEMPLATE/bug_report.md          | 58 +++++++++++++++++++
 .../ISSUE_TEMPLATE/pull_request_template.md   | 39 +++++++++++++
 2 files changed, 97 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/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..c4cc4136
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,58 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ""
+labels: ""
+assignees: ""
+---
+
+<!--- Please provide an intuitive Title  -->
+<!--- Title Example: Using the SDK I fail sending a GMP from Eth to Polygon -->
+
+## Short Context
+<!--- Please provide a short context description of what is the problem  -->
+<!--- Example: Trying to use the SDK example from https://docs.buildwithsygma.com/sdk/examples/evm-example/ I did encounter an issue when trying to send the ERC20_Test tokens from Sepolia to Goerli.  -->
+
+## Preconditions
+<!-- Exmaple of preconditions: 
+1. Own a wallet with gas token on Sepolia chain.
+2. Have access to  an RPC provider for Sepolia chain.
+3. Get ERC20_Test tokens from Sygma Faucet: https://faucet-ui-stage.buildwithsygma.com/ 
+4. OS: Linux Ubuntu 18.0 LTS; Node version 20; Yarn version: 5.0 -->
+1.
+2.
+
+## Steps to Reproduce
+
+<!--- Provide a link to a live example, or an unambiguous set of steps to -->
+<!--- reproduce this bug. Include code to reproduce, if relevant -->
+<!--- Example: 
+1. Clone the Sygma SDK sample from https://github.com/sygmaprotocol/sygma-sdk/tree/main/examples/evm-to-evm-fungible-transfer . 
+2. Build dependency with recommended commands: yarn install followed by yarn sdk:build
+3. Go to root folder examples/evm-to-evm-fungible-transfer and execute yarn run transfer -->
+1.
+2.
+3.
+4.
+
+## Expected Behavior
+
+<!--- If you're describing a bug, tell us what should happen -->
+<!--- If you're suggesting a change/improvement, tell us how it should work -->
+
+## Actual Behavior
+
+<!--- If describing a bug, tell us what happens instead of the expected behavior -->
+<!--- If suggesting a change/improvement, explain the difference from current behavior -->
+
+## Possible Solution (optional)
+
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change -->
+
+## Version
+
+Sygma commit (or docker tag):
+sygma-solidity version:
+sygma-substrate version:
+Go version:
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/pull_request_template.md b/.github/ISSUE_TEMPLATE/pull_request_template.md
new file mode 100644
index 00000000..1cb2f344
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/pull_request_template.md
@@ -0,0 +1,39 @@
+<!--- Provide a general summary of your changes in the Title above -->
+
+## Description
+
+<!--- Describe your changes in detail -->
+
+## Related Issue Or Context
+
+<!--- If suggesting a new feature or change, please discuss it in an issue first -->
+<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
+<!--- Otherwise, describe context and motivation for change here -->
+
+Closes: #<issue>
+
+## How Has This Been Tested? Testing details.
+
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, and the tests you ran to -->
+<!--- see how your change affects other areas of the code, etc. -->
+
+## Types of changes
+
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+- [ ] Documentation
+
+## Checklist:
+
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+
+- [ ] I have commented my code, particularly in hard-to-understand areas.
+- [ ] I have ensured that all acceptance criteria (or expected behavior) from issue are met
+- [ ] I have updated the documentation locally and in sygma-docs.
+- [ ] I have added tests to cover my changes.
+- [ ] I have ensured that all the checks are passing and green, I've signed the CLA bot
\ No newline at end of file