Merge pull request #544 from zama-ai/templates

Adding templates for easier handling of customer support

.github/ISSUE_TEMPLATE/bug_report_fhevm.md

@@ -0,0 +1,56 @@
+---
+name: Smart Contracts Bug Report
+about: Use this template to report issues encountered with confidential smart contracts on the FHEVM.
+title: ""
+labels: bug
+assignees: ""
+---
+
+### **Description**
+
+Provide a clear and detailed description of the bug.
+
+### **Expected Behavior**
+
+Describe what you expected to happen (e.g., successful decryption of the input, valid output from the encrypted function, no gas estimation errors).
+
+### **Screenshots / Logs**
+
+Include screenshots, relevant logs, or traces if available, particularly for encrypted computations or gateway interactions.
+
+### **Smart Contract Code Snippet**
+
+If applicable, provide a minimal reproducible example of the smart contract code highlighting the part where the issue occurs:
+
+<details><summary>Example</summary>
+<p>
+
+```solidity
+// Example
+contract Counter {
+  uint32 value;
+  function increment() public {
+    value += 1;
+  }
+
+  function currentValue() public view returns (uint32) {
+    return value;
+  }
+}
+```
+
+</p>
+</details>
+
+### **Environment Information**
+
+Fill in the relevant environment details where the issue was observed:
+
+- **Operating System**: [e.g., Ubuntu 20.04, Windows 10]
+- **Browser**: [e.g., Chrome v90, Safari v14]
+- **FHEVM Version**: [e.g., v1.0.0]
+- **Tooling**: [Hardhat, Remix, FHEVM CLI]
+- **Devnet / Local Node Configuration**:
+  - Chain ID: [e.g., 9000]
+  - RPC URL: [e.g., `https://devnet.zama.ai`]
+  - Faucet Usage: [Yes/No]

.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:
+
+<details><summary>Logs or output</summary>
+<p>
+
+```console
+
+```
+
+</p>
+</details>
+
+---
+
+By including these details, we can ensure a faster and more accurate resolution for your issue. Thank you for helping improve `fhevmjs`!

.github/ISSUE_TEMPLATE/docs_bug_report.md

@@ -0,0 +1,70 @@
+---
+name: Documentation Bug Report / Unclear Documentation
+about: Use this template to report issues, inconsistencies, or inaccuracies in our documentation. Or to report sections of our documentation that are unclear, confusing, or require further explanation.
+title: ""
+labels: bug, documentation
+assignees: ""
+---
+
+### **Page Link**
+
+Please provide a link to the page where the issue is located:  
+**URL**: '[https://docs.zama.ai/fhevm/\_\_\_](https://docs.zama.ai/fhevm/___)'
+
+### **Description**
+
+Describe in detail what part of the documentation is unclear or provide a clear and detailed description of the bug. Include any inconsistencies, typos, broken links, or missing information.
+
+<details><summary>For example:</summary>
+<p>
+ <li>Inaccurate technical explanations or missing prerequisites.</li>
+ <li>Deprecated code snippets or outdated references.</li>
+ <li>Formatting issues or broken links.</li>
+ <li>Is there a lack of explanation for certain technical terms or concepts?</li>
+ <li>Are there missing examples for a complex function or feature?</li>
+ <li>Does the documentation assume prior knowledge that hasn't been introduced?</li>
+</p>
+</details>
+
+### **Suggested Fix / Expected Behavior / What Would You Like Clarified?**
+
+Please provide your suggestions for improvement or clarification:
+
+- Describe expected content or suggest corrections for bugs/inaccuracies.
+- Explain what needs clarification for unclear documentation.
+
+<details><summary>Examples of helpful suggestions:</summary>
+<p>
+ <li>Corrected code snippet</li>
+ <li>Improved explanation.</li>
+ <li>Link to a more accurate or up-to-date resource</li>
+</p>
+</details>
+
+<details><summary>Examples of clarification requests:</summary>
+<p>
+ <li>“Can you provide an example of this function in use?”</li>
+ <li>"What are the expected inputs and outputs for this operation?”</li>
+ <li>“Could you add a section explaining how this feature integrates with other components?”</li>
+</p>
+</details>
+
+### **Screenshots / Logs**
+
+If applicable, provide screenshots, code snippets, or logs that clearly show the issue.
+
+### **Impact Level**
+
+Choose the impact of the bug on the documentation quality and user experience:
+
+<details><summary>[Critical, Moderate, Minor]</summary>
+<p>
+<li><b>Critical</b>: Major error that could lead to incorrect implementation or misunderstanding.</li>
+<li><b>Moderate</b>: Somewhat misleading information, but unlikely to cause implementation issues.</li>
+<li><b>Minor</b>: Minor typo or aesthetic issue with no functional impact.</li>
+</p>
+</details>
+
+---
+
+By including these details, we can ensure a faster and more accurate resolution for your issue. Thank you for helping improve `fhEVM docs`!

.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.

.gitignore

@@ -7,6 +7,7 @@ yarn-error.log*
 lerna-debug.log*
 pnpm-lock.yaml
 yarn.lock
+.vscode
 
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json