From 06da93b2f1701e04236507daa5325a6715a68d4d Mon Sep 17 00:00:00 2001 From: nidhi-singh02 Date: Tue, 14 Oct 2025 13:02:31 +0530 Subject: [PATCH 1/4] PR template for hackathon purpose --- .github/pull_request_template.md | 125 +++++++++++++++++++++++++++++++ 1 file changed, 125 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..86410438 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,125 @@ +# ๐ŸŽฒ Pyth Entropy Hackathon Submission + +## ๐Ÿ“‹ Project Information + +**Project Name:** + +**Team/Individual:** + +**Hackathon Event:** + +**Contact:** + +## Project Description + +### What does your project do? + + +### How does it use Pyth Entropy? + + +### What problem does it solve? + + +## Technical Implementation + +### Architecture Overview + + +**Network Details:** + +### Smart Contract Details +**Contract Address(es):** + +## Project Structure + +### Directory Structure +``` +entropy/[your-project-name]/ +โ”œโ”€โ”€ contract/ # Smart contracts +โ”œโ”€โ”€ app/ # Frontend application (if applicable) +โ”œโ”€โ”€ README.md # Project documentation +โ””โ”€โ”€ ... +``` + +## Demo & Usage + +### Live Demo +**Demo URL:** + +**Video Demo:** + +### How to Run Locally + +#### Prerequisites + +- Node.js version: ___ +- Other dependencies: ___ + +#### Installation & Setup +```bash +# Add your installation commands here +cd entropy/[your-project-name] +npm install +# ... other setup commands +``` + +#### Running the Application +```bash +# Add commands to run your application +npm run dev +# or other run commands +``` + +## Technical Challenges & Solutions + +### Challenges Faced + + +### How You Solved Them + + +## ๐Ÿ“š Documentation + +### README.md Checklist +- [ ] Clear project description +- [ ] Installation instructions +- [ ] Usage examples +- [ ] Architecture explanation +- [ ] Entropy integration details +- [ ] Demo links/screenshots + +### Code Documentation +- [ ] Smart contracts are well-commented +- [ ] Complex logic is explained + +## ๐Ÿงช Testing & Verification + +### Smart Contract Testing +- [ ] Unit tests written and passing +- [ ] Entropy callback functionality tested +- [ ] Edge cases covered + +### Deployment Verification +- [ ] Contract deployed successfully +- [ ] Contract verified on block explorer +- [ ] All functions working as expected + +--- + +### Known Issues + + +### Future Roadmap + + +--- + +**Thank you for reviewing my hackathon submission! ๐Ÿ™** + + From 1c3db47afa76071a6a11611eb5b7000d6f14f9e7 Mon Sep 17 00:00:00 2001 From: nidhi-singh02 Date: Tue, 14 Oct 2025 13:07:13 +0530 Subject: [PATCH 2/4] updated the template --- .github/pull_request_template.md | 39 ++------------------------------ 1 file changed, 2 insertions(+), 37 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 86410438..54a27aca 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,6 +1,6 @@ # ๐ŸŽฒ Pyth Entropy Hackathon Submission -## ๐Ÿ“‹ Project Information +## Project Information **Project Name:** @@ -33,7 +33,6 @@ ## Project Structure -### Directory Structure ``` entropy/[your-project-name]/ โ”œโ”€โ”€ contract/ # Smart contracts @@ -79,43 +78,9 @@ npm run dev ### How You Solved Them -## ๐Ÿ“š Documentation - -### README.md Checklist -- [ ] Clear project description -- [ ] Installation instructions -- [ ] Usage examples -- [ ] Architecture explanation -- [ ] Entropy integration details -- [ ] Demo links/screenshots - -### Code Documentation -- [ ] Smart contracts are well-commented -- [ ] Complex logic is explained - -## ๐Ÿงช Testing & Verification - -### Smart Contract Testing -- [ ] Unit tests written and passing -- [ ] Entropy callback functionality tested -- [ ] Edge cases covered - -### Deployment Verification -- [ ] Contract deployed successfully -- [ ] Contract verified on block explorer -- [ ] All functions working as expected - ---- - -### Known Issues - - -### Future Roadmap - - --- -**Thank you for reviewing my hackathon submission! ๐Ÿ™** +**Thank you for reviewing my hackathon submission!** - -**Team/Individual:** +## Type of Contribution + -**Hackathon Event:** +- [ ] **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) -**Contact:** +## Project Information -## Project Description +**Project/Example Name:** -### What does your project do? - +**Pyth Product Used:** +- [ ] Pyth Price Feeds +- [ ] Pyth Entropy +- [ ] Multiple Products +- [ ] Other: ___________ -### How does it use Pyth Entropy? - +**Blockchain/Platform:** +- [ ] Ethereum/EVM +- [ ] Solana +- [ ] Aptos +- [ ] Sui +- [ ] Fuel +- [ ] Starknet +- [ ] TON +- [ ] Other: ___________ -### What problem does it solve? - +## Description -## Technical Implementation +### What does this contribution do? + -### Architecture Overview - +### How does it integrate with Pyth? + -**Network Details:** +### What problem does it solve or demonstrate? + -### Smart Contract Details -**Contract Address(es):** +## Changes Made -## Project Structure +### Files Added/Modified + +- [ ] Smart contracts +- [ ] Frontend/UI components +- [ ] Documentation (README, comments) +- [ ] Configuration files +- [ ] Tests +- [ ] Other: ___________ +### Directory Structure (for new examples) + ``` -entropy/[your-project-name]/ -โ”œโ”€โ”€ contract/ # Smart contracts -โ”œโ”€โ”€ app/ # Frontend application (if applicable) +[product]/[example-name]/ +โ”œโ”€โ”€ contract/ # Smart contracts (if applicable) +โ”œโ”€โ”€ app/ # Frontend application (if applicable) โ”œโ”€โ”€ README.md # Project documentation โ””โ”€โ”€ ... ``` -## Demo & Usage +## Testing & Verification -### Live Demo -**Demo URL:** - -**Video Demo:** - -### How to Run Locally +### How to Test This Contribution + #### Prerequisites - + - Node.js version: ___ - Other dependencies: ___ -#### Installation & Setup +#### Setup & Run Instructions ```bash -# Add your installation commands here -cd entropy/[your-project-name] +# Add your setup and run commands here +cd [path-to-your-example] npm install -# ... other setup commands +# ... other commands ``` -#### Running the Application -```bash -# Add commands to run your application -npm run dev -# or other run commands -``` +### Deployment Information (if applicable) +**Network:** + +**Contract Address(es):** + +**Demo URL:** + +## Documentation + +- [ ] Added/updated README.md with clear instructions +- [ ] Code is well-commented and self-explanatory +- [ ] Included usage examples +- [ ] Added any necessary configuration details + +## 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 -## Technical Challenges & Solutions +### Related Issues + +Fixes # -### Challenges Faced - +### Screenshots/Demo (if applicable) + -### How You Solved Them - +### Notes for Reviewers + --- -**Thank you for reviewing my hackathon submission!** +**Thank you for contributing to Pyth Examples!** From 08892e072c5632e1d3f41820d425cb5a40a6eeda Mon Sep 17 00:00:00 2001 From: nidhi-singh02 Date: Tue, 14 Oct 2025 13:15:42 +0530 Subject: [PATCH 4/4] edited the template --- .github/pull_request_template.md | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 23b15133..ac9fb9bc 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -40,17 +40,6 @@ ### What problem does it solve or demonstrate? -## Changes Made - -### Files Added/Modified - -- [ ] Smart contracts -- [ ] Frontend/UI components -- [ ] Documentation (README, comments) -- [ ] Configuration files -- [ ] Tests -- [ ] Other: ___________ - ### Directory Structure (for new examples) ``` @@ -86,13 +75,6 @@ npm install **Demo URL:** -## Documentation - -- [ ] Added/updated README.md with clear instructions -- [ ] Code is well-commented and self-explanatory -- [ ] Included usage examples -- [ ] Added any necessary configuration details - ## Checklist ### Code Quality