From 0388fb9473095a2488a487030a0b8636c4bbfde3 Mon Sep 17 00:00:00 2001 From: Aurora Poppyseed <30662672+poppyseedDev@users.noreply.github.com> Date: Wed, 30 Oct 2024 16:26:18 +0100 Subject: [PATCH 1/2] docs: added issue template to fhevmjs --- .github/ISSUE_TEMPLATE/bug_report_fhevmjs.md | 54 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 16 ++++++ 2 files changed, 70 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report_fhevmjs.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report_fhevmjs.md b/.github/ISSUE_TEMPLATE/bug_report_fhevmjs.md new file mode 100644 index 0000000..6720fcb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report_fhevmjs.md @@ -0,0 +1,54 @@ +--- +name: 🐛 fhevmjs Bug report +about: Use this template to report issues encountered while using the fhevmjs library for interacting with fhEVM smart contracts. +title: "" +labels: bug, fhevmjs +assignees: "" +--- + +### **Description** + +Provide a clear and detailed description of the issue encountered. + +### **Expected Behavior** + +A clear and concise description of the expected behavior (e.g., successful encryption of parameters, correct reencryption result, accurate balance retrieval). + +### **Screenshots / Logs** + +If applicable, provide screenshots or logs that capture the issue. Include any console errors, warnings, or unexpected outputs. + +### **Environment Information** + +Fill in the relevant environment details where the issue was observed: + +- **Browser**: [e.g., Chrome v90, Firefox v88] +- **Node.js Version**: [e.g., `v14.17.0`] +- **`fhEVMjs` Version**: [e.g., `v0.2.1`] +- **Package Manager**: [npm, yarn, pnpm] +- **Network Configuration**: + - **Chain ID**: [e.g., `9000`] + - **RPC URL**: [e.g., `https://devnet.zama.ai`] + - **Gateway URL**: [e.g., `https://gateway.devnet.zama.ai`] + +### **Steps Taken to Debug** + +Outline any steps you’ve taken to troubleshoot the issue (e.g., using mocked mode, enabling verbose logging, testing with a different environment or network). + +### **Resources / References** + +If applicable, include links to any related documentation or reference materials that may help us understand the context: + +
Logs or output +

+ +```console + +``` + +

+
+ +--- + +By including these details, we can ensure a faster and more accurate resolution for your issue. Thank you for helping improve `fhevmjs`! diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 0000000..f9b21c9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,16 @@ +--- +name: 🚀 General feature request for fhEVM +about: Suggest an idea for this project +title: "" +labels: enhancement +assignees: "" +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Additional context** +Add any other context or screenshots about the feature request here. From 2d5ac678f9ce13eab03fabf170517f5b8d7e4045 Mon Sep 17 00:00:00 2001 From: Aurora Poppyseed <30662672+poppyseedDev@users.noreply.github.com> Date: Thu, 31 Oct 2024 00:42:19 +0900 Subject: [PATCH 2/2] Rename bug_report_fhevmjs.md to bug_report.md --- .github/ISSUE_TEMPLATE/{bug_report_fhevmjs.md => bug_report.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/ISSUE_TEMPLATE/{bug_report_fhevmjs.md => bug_report.md} (100%) diff --git a/.github/ISSUE_TEMPLATE/bug_report_fhevmjs.md b/.github/ISSUE_TEMPLATE/bug_report.md similarity index 100% rename from .github/ISSUE_TEMPLATE/bug_report_fhevmjs.md rename to .github/ISSUE_TEMPLATE/bug_report.md