Skip to content

Commit

Permalink
docs: copy issue templates and config from xeon-dapp
Browse files Browse the repository at this point in the history
  • Loading branch information
Jon Bray committed Jul 27, 2024
1 parent 6709b94 commit be52a27
Show file tree
Hide file tree
Showing 5 changed files with 172 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/issue_template/01-bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug report
about: Submit a bug or issue report.
title: 'bug: '
labels: 'type: bug'
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
23 changes: 23 additions & 0 deletions .github/issue_template/02-feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Feature request
about: Suggest a new idea for this project
title: 'feat:'
labels: 'status: discussing, type: feature request'
assignees: heyJonBray

---

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

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Have you seen a similar feature elsewhere?**
Please provide any references. Ex. So-and-so has a feature that [...]

**Additional context**
Add any other context or screenshots about the feature request here.
20 changes: 20 additions & 0 deletions .github/issue_template/03-improvement-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Improvement request
about: Suggest ways to improve existing features.
title: 'update:'
labels: 'status: discussing, type: enhancement'
assignees: heyJonBray

---

**Please describe the specific feature you'd like updated**
A concise description of the current feature.

**Describe the enhancement you'd like to see**
A clear and concise description of what you want to happen. Ex. If would be nice if [...]

**Have you seen a similar feature elsewhere?**
Any references to other features in the wild. Ex. So-and-so's feature does [...]

**Additional context**
Add any other context or screenshots about the feature request here.
74 changes: 74 additions & 0 deletions .github/issue_template/04-audit-submission.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
name: Solidity Audit Submission
about: Begin an audit submission on Xeon Protocol v1-core contracts.
title: 'xeon-v1-core audit [MM-DD-YYYY]-[yourName]'
labels: 'type: audit, status: discussing'
assignees: heyJonBray, wellytg, neonhedge
---

# Solidity Audit Submission: [Xeon Protocol v1-core](https://github.com/xeon-protocol/v1-core)

_Please use this template to submit your audit findings for the Xeon Protocol v1-core contracts. Your thorough analysis and insights are invaluable for ensuring the security and robustness of our codebase. We look forward to your detailed report and any recommendations for improvement._

## Auditor Information

**Auditor Name:** [Your Name]
**Affiliation:** [Your Company or Independent]
**Contact Information:** [Email or preferred contact method]

## Audit Scope and Objectives

**Audit Scope:** [Indicate specific contracts (`XeonHedging.sol`, `XeonStaking.sol`, `PriceOracle.sol`) or `FULL AUDIT` for all contracts.]

**Audit Objectives:**

- **Security Vulnerabilities:** [Detail the focus on potential security vulnerabilities]
- **Code Quality:** [Comment on code readability, maintainability, and clarity]
- **Performance Considerations:** [Evaluate gas efficiency and optimization]
- **Compliance:** [Check for compliance with best practices and standards]

## Methodology and Tools

- **Audit Methodology:** [Describe the methodology used, such as manual code review, static analysis tools, etc.]
- **Tools Used:** [List any tools or frameworks used during the audit, e.g., MythX, Slither, Echidna]

## Findings and Recommendations

### **Summary of Findings:**

- **Critical Issues:** [List any critical security vulnerabilities found, if applicable]
- **High Priority Issues:** [List high priority issues and their potential impact]
- **Medium Priority Issues:** [Detail medium priority issues and suggested improvements]
- **Low Priority Issues:** [Mention any low priority issues or minor recommendations]

### **Detailed Findings:**

- **Issue 1: [Title of Issue]**

- **Description:** [Detailed description of the issue]
- **Location:** [Specify the file and line number, if applicable]
- **Impact:** [Describe the potential impact of the issue]
- **Recommendation:** [Provide recommendations for mitigation or improvement]

- **Issue 2: [Title of Issue]**

- **Description:** [Detailed description of the issue]
- **Location:** [Specify the file and line number, if applicable]
- **Impact:** [Describe the potential impact of the issue]
- **Recommendation:** [Provide recommendations for mitigation or improvement]

- [Include more issues as needed...]

## General Comments

- **Overall Assessment:** [Provide an overall assessment of the code quality and security]
- **Positive Aspects:** [Highlight any particularly well-implemented aspects]
- **Areas for Improvement:** [Suggest areas where the codebase could be improved]

## Follow-Up and Communication

- **Next Steps:** [Outline any next steps or follow-up actions]
- **Preferred Communication:** [Specify the preferred method of communication for any questions or clarifications]
- **Response Time:** [Indicate your availability and expected response times for addressing any questions]

---
17 changes: 17 additions & 0 deletions .github/issue_template/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
blank_issues_enabled: false
contact_links:
- name: Dev Support
url: mailto:[email protected]
about: If you need support or have questions, please contact the developer.
- name: GitBook
url: https://xeon-protocol.gitbook.io/documentation/
about: Learn more about Xeon Protocol
- name: Warpcast
url: https://warpcast.com/xeonprotocol
about: Contact us on Warpcast
- name: Twitter
url: https://twitter.com/xeonprotocol
about: Contact us on Twitter
- name: Telegram
url: https://t.me/XeonProtocolPortal
about: Join us on Telegram

0 comments on commit be52a27

Please sign in to comment.