Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 112 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
# Pyth Examples Contribution

## Type of Contribution
<!-- Please check the type of contribution this PR represents -->

- [ ] **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:** <!-- Enter the name of your project or the example you're working on -->

**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?
<!-- Provide a clear description of what you're adding or changing -->

### How does it integrate with Pyth?
<!-- Explain how your code uses Pyth products/services -->

### What problem does it solve or demonstrate?
<!-- Describe the use case or issue this addresses -->

### Directory Structure (for new examples)
<!-- If adding a new example, show the directory structure -->
```
[product]/[example-name]/
├── contract/ # Smart contracts (if applicable)
├── app/ # Frontend application (if applicable)
├── README.md # Project documentation
└── ...
```

## Testing & Verification

### How to Test This Contribution
<!-- Provide clear instructions for reviewers to test your changes -->

#### Prerequisites
<!-- List any prerequisites needed -->
- 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:** <!-- e.g., Ethereum Sepolia, Solana Devnet, etc. -->

**Contract Address(es):** <!-- Deployed contract addresses -->

**Demo URL:** <!-- Link to live demo if available -->

## 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
<!-- Link any related GitHub issues -->
Fixes #<!-- issue number -->

### Screenshots/Demo (if applicable)
<!-- Add screenshots or links to demos that help explain your contribution -->

### Notes for Reviewers
<!-- Add any additional context that would help reviewers -->

---

**Thank you for contributing to Pyth Examples!**

<!--
Helpful Resources:
- Pyth Documentation: https://docs.pyth.network/
- Price Feeds: https://docs.pyth.network/price-feeds
- Entropy: https://docs.pyth.network/entropy
- Lazer: https://docs.pyth.network/lazer
- Existing Examples: Browse the repository for reference implementations
-->