diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..ac9fb9bc --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,112 @@ +# Pyth Examples Contribution + +## Type of Contribution + + +- [ ] **New Example Project** (Adding a new example to demonstrate Pyth integration) +- [ ] **Bug Fix** (Fixing an issue in existing examples) +- [ ] **Documentation Update** (Improving README, comments, or guides) +- [ ] **Enhancement** (Improving existing functionality or adding features) +- [ ] **Hackathon Submission** (Submitting a project from a hackathon) + +## Project Information + +**Project/Example Name:** + +**Pyth Product Used:** +- [ ] Pyth Price Feeds +- [ ] Pyth Entropy +- [ ] Multiple Products +- [ ] Other: ___________ + +**Blockchain/Platform:** +- [ ] Ethereum/EVM +- [ ] Solana +- [ ] Aptos +- [ ] Sui +- [ ] Fuel +- [ ] Starknet +- [ ] TON +- [ ] Other: ___________ + +## Description + +### What does this contribution do? + + +### How does it integrate with Pyth? + + +### What problem does it solve or demonstrate? + + +### Directory Structure (for new examples) + +``` +[product]/[example-name]/ +├── contract/ # Smart contracts (if applicable) +├── app/ # Frontend application (if applicable) +├── README.md # Project documentation +└── ... +``` + +## Testing & Verification + +### How to Test This Contribution + + +#### Prerequisites + +- Node.js version: ___ +- Other dependencies: ___ + +#### Setup & Run Instructions +```bash +# Add your setup and run commands here +cd [path-to-your-example] +npm install +# ... other commands +``` + +### Deployment Information (if applicable) +**Network:** + +**Contract Address(es):** + +**Demo URL:** + +## Checklist + +### Code Quality +- [ ] Code follows existing patterns in the repository +- [ ] Proper error handling implemented +- [ ] No hardcoded values (use environment variables where appropriate) + +### Testing +- [ ] Tested locally and works as expected +- [ ] All existing functionality still works (no breaking changes) + +## Additional Context + +### Related Issues + +Fixes # + +### Screenshots/Demo (if applicable) + + +### Notes for Reviewers + + +--- + +**Thank you for contributing to Pyth Examples!** + +