Skip to content

Commit 07fc22b

Browse files
feat(PR template for examples): Create a generic PR template that can used for all contributions (#66)
* PR template for hackathon purpose * updated the template * a generic template for the examples * edited the template
1 parent 02c75d1 commit 07fc22b

File tree

1 file changed

+112
-0
lines changed

1 file changed

+112
-0
lines changed

.github/pull_request_template.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# Pyth Examples Contribution
2+
3+
## Type of Contribution
4+
<!-- Please check the type of contribution this PR represents -->
5+
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)
11+
12+
## Project Information
13+
14+
**Project/Example Name:** <!-- Enter the name of your project or the example you're working on -->
15+
16+
**Pyth Product Used:**
17+
- [ ] Pyth Price Feeds
18+
- [ ] Pyth Entropy
19+
- [ ] Multiple Products
20+
- [ ] Other: ___________
21+
22+
**Blockchain/Platform:**
23+
- [ ] Ethereum/EVM
24+
- [ ] Solana
25+
- [ ] Aptos
26+
- [ ] Sui
27+
- [ ] Fuel
28+
- [ ] Starknet
29+
- [ ] TON
30+
- [ ] Other: ___________
31+
32+
## Description
33+
34+
### What does this contribution do?
35+
<!-- Provide a clear description of what you're adding or changing -->
36+
37+
### How does it integrate with Pyth?
38+
<!-- Explain how your code uses Pyth products/services -->
39+
40+
### What problem does it solve or demonstrate?
41+
<!-- Describe the use case or issue this addresses -->
42+
43+
### Directory Structure (for new examples)
44+
<!-- If adding a new example, show the directory structure -->
45+
```
46+
[product]/[example-name]/
47+
├── contract/ # Smart contracts (if applicable)
48+
├── app/ # Frontend application (if applicable)
49+
├── README.md # Project documentation
50+
└── ...
51+
```
52+
53+
## Testing & Verification
54+
55+
### How to Test This Contribution
56+
<!-- Provide clear instructions for reviewers to test your changes -->
57+
58+
#### Prerequisites
59+
<!-- List any prerequisites needed -->
60+
- Node.js version: ___
61+
- Other dependencies: ___
62+
63+
#### Setup & Run Instructions
64+
```bash
65+
# Add your setup and run commands here
66+
cd [path-to-your-example]
67+
npm install
68+
# ... other commands
69+
```
70+
71+
### Deployment Information (if applicable)
72+
**Network:** <!-- e.g., Ethereum Sepolia, Solana Devnet, etc. -->
73+
74+
**Contract Address(es):** <!-- Deployed contract addresses -->
75+
76+
**Demo URL:** <!-- Link to live demo if available -->
77+
78+
## Checklist
79+
80+
### Code Quality
81+
- [ ] Code follows existing patterns in the repository
82+
- [ ] Proper error handling implemented
83+
- [ ] No hardcoded values (use environment variables where appropriate)
84+
85+
### Testing
86+
- [ ] Tested locally and works as expected
87+
- [ ] All existing functionality still works (no breaking changes)
88+
89+
## Additional Context
90+
91+
### Related Issues
92+
<!-- Link any related GitHub issues -->
93+
Fixes #<!-- issue number -->
94+
95+
### Screenshots/Demo (if applicable)
96+
<!-- Add screenshots or links to demos that help explain your contribution -->
97+
98+
### Notes for Reviewers
99+
<!-- Add any additional context that would help reviewers -->
100+
101+
---
102+
103+
**Thank you for contributing to Pyth Examples!**
104+
105+
<!--
106+
Helpful Resources:
107+
- Pyth Documentation: https://docs.pyth.network/
108+
- Price Feeds: https://docs.pyth.network/price-feeds
109+
- Entropy: https://docs.pyth.network/entropy
110+
- Lazer: https://docs.pyth.network/lazer
111+
- Existing Examples: Browse the repository for reference implementations
112+
-->

0 commit comments

Comments
 (0)