Skip to content

Commit c5dec6a

Browse files
committed
a generic template for the examples
1 parent 1c3db47 commit c5dec6a

File tree

1 file changed

+93
-53
lines changed

1 file changed

+93
-53
lines changed

.github/pull_request_template.md

Lines changed: 93 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,130 @@
1-
# 🎲 Pyth Entropy Hackathon Submission
1+
# Pyth Examples Contribution
22

3-
## Project Information
4-
5-
**Project Name:** <!-- Enter your project name -->
6-
7-
**Team/Individual:** <!-- Your name or team name -->
3+
## Type of Contribution
4+
<!-- Please check the type of contribution this PR represents -->
85

9-
**Hackathon Event:** <!-- Name of the hackathon -->
6+
- [ ] **New Example Project** (Adding a new example to demonstrate Pyth integration)
7+
- [ ] **Bug Fix** (Fixing an issue in existing examples)
8+
- [ ] **Documentation Update** (Improving README, comments, or guides)
9+
- [ ] **Enhancement** (Improving existing functionality or adding features)
10+
- [ ] **Hackathon Submission** (Submitting a project from a hackathon)
1011

11-
**Contact:** <!-- Your GitHub username, email, or Discord handle -->
12+
## Project Information
1213

13-
## Project Description
14+
**Project/Example Name:** <!-- Enter the name of your project or the example you're working on -->
1415

15-
### What does your project do?
16-
<!-- Provide a clear, concise description of your entropy-based application -->
16+
**Pyth Product Used:**
17+
- [ ] Pyth Price Feeds
18+
- [ ] Pyth Entropy
19+
- [ ] Multiple Products
20+
- [ ] Other: ___________
1721

18-
### How does it use Pyth Entropy?
19-
<!-- Explain how your project integrates with Pyth Entropy and what randomness features you utilize -->
22+
**Blockchain/Platform:**
23+
- [ ] Ethereum/EVM
24+
- [ ] Solana
25+
- [ ] Aptos
26+
- [ ] Sui
27+
- [ ] Fuel
28+
- [ ] Starknet
29+
- [ ] TON
30+
- [ ] Other: ___________
2031

21-
### What problem does it solve?
22-
<!-- Describe the real-world problem your project addresses -->
32+
## Description
2333

24-
## Technical Implementation
34+
### What does this contribution do?
35+
<!-- Provide a clear description of what you're adding or changing -->
2536

26-
### Architecture Overview
27-
<!-- Briefly describe your project's architecture -->
37+
### How does it integrate with Pyth?
38+
<!-- Explain how your code uses Pyth products/services -->
2839

29-
**Network Details:** <!-- e.g., Ethereum Sepolia, Arbitrum Sepolia, etc. -->
40+
### What problem does it solve or demonstrate?
41+
<!-- Describe the use case or issue this addresses -->
3042

31-
### Smart Contract Details
32-
**Contract Address(es):** <!-- Deployed contract addresses -->
43+
## Changes Made
3344

34-
## Project Structure
45+
### Files Added/Modified
46+
<!-- List the main files you've added or modified -->
47+
- [ ] Smart contracts
48+
- [ ] Frontend/UI components
49+
- [ ] Documentation (README, comments)
50+
- [ ] Configuration files
51+
- [ ] Tests
52+
- [ ] Other: ___________
3553

54+
### Directory Structure (for new examples)
55+
<!-- If adding a new example, show the directory structure -->
3656
```
37-
entropy/[your-project-name]/
38-
├── contract/ # Smart contracts
39-
├── app/ # Frontend application (if applicable)
57+
[product]/[example-name]/
58+
├── contract/ # Smart contracts (if applicable)
59+
├── app/ # Frontend application (if applicable)
4060
├── README.md # Project documentation
4161
└── ...
4262
```
4363

44-
## Demo & Usage
64+
## Testing & Verification
4565

46-
### Live Demo
47-
**Demo URL:** <!-- Link to your live demo (if available) -->
48-
49-
**Video Demo:** <!-- Link to video demonstration -->
50-
51-
### How to Run Locally
66+
### How to Test This Contribution
67+
<!-- Provide clear instructions for reviewers to test your changes -->
5268

5369
#### Prerequisites
54-
<!-- List any prerequisites needed to run your project -->
70+
<!-- List any prerequisites needed -->
5571
- Node.js version: ___
5672
- Other dependencies: ___
5773

58-
#### Installation & Setup
74+
#### Setup & Run Instructions
5975
```bash
60-
# Add your installation commands here
61-
cd entropy/[your-project-name]
76+
# Add your setup and run commands here
77+
cd [path-to-your-example]
6278
npm install
63-
# ... other setup commands
79+
# ... other commands
6480
```
6581

66-
#### Running the Application
67-
```bash
68-
# Add commands to run your application
69-
npm run dev
70-
# or other run commands
71-
```
82+
### Deployment Information (if applicable)
83+
**Network:** <!-- e.g., Ethereum Sepolia, Solana Devnet, etc. -->
84+
85+
**Contract Address(es):** <!-- Deployed contract addresses -->
86+
87+
**Demo URL:** <!-- Link to live demo if available -->
88+
89+
## Documentation
90+
91+
- [ ] Added/updated README.md with clear instructions
92+
- [ ] Code is well-commented and self-explanatory
93+
- [ ] Included usage examples
94+
- [ ] Added any necessary configuration details
95+
96+
## Checklist
97+
98+
### Code Quality
99+
- [ ] Code follows existing patterns in the repository
100+
- [ ] Proper error handling implemented
101+
- [ ] No hardcoded values (use environment variables where appropriate)
102+
103+
### Testing
104+
- [ ] Tested locally and works as expected
105+
- [ ] All existing functionality still works (no breaking changes)
106+
107+
## Additional Context
72108

73-
## Technical Challenges & Solutions
109+
### Related Issues
110+
<!-- Link any related GitHub issues -->
111+
Fixes #<!-- issue number -->
74112

75-
### Challenges Faced
76-
<!-- Describe any technical challenges you encountered -->
113+
### Screenshots/Demo (if applicable)
114+
<!-- Add screenshots or links to demos that help explain your contribution -->
77115

78-
### How You Solved Them
79-
<!-- Explain your solutions and any innovative approaches -->
116+
### Notes for Reviewers
117+
<!-- Add any additional context that would help reviewers -->
80118

81119
---
82120

83-
**Thank you for reviewing my hackathon submission!**
121+
**Thank you for contributing to Pyth Examples!**
84122

85123
<!--
86-
Helpful Links:
87-
- Pyth Entropy Documentation: https://docs.pyth.network/entropy
88-
- Example Projects: Check the existing entropy/ directory for reference implementations
89-
- Pyth Discord: [Add Discord link for support]
124+
Helpful Resources:
125+
- Pyth Documentation: https://docs.pyth.network/
126+
- Price Feeds: https://docs.pyth.network/price-feeds
127+
- Entropy: https://docs.pyth.network/entropy
128+
- Lazer: https://docs.pyth.network/lazer
129+
- Existing Examples: Browse the repository for reference implementations
90130
-->

0 commit comments

Comments
 (0)