Contributing
Pridge is open source and welcomes contributions.
Repository
bash
git clone https://github.com/xvoidlabs/pridge
cd pridgeDevelopment Setup
Main App
bash
# Install dependencies
npm install
# Create environment file
cp env.example .env
# Add your Helius API key
# Start dev server
npm run devDocumentation
bash
cd docs
npm install
npm run devProject Structure
pridge/
├── src/
│ ├── main.ts # App entry, routing
│ ├── keypair.ts # Key generation
│ ├── claim.ts # Claim logic
│ ├── debridge.ts # Bridge API
│ ├── evm-wallet.ts # MetaMask
│ ├── solana-wallet.ts # Phantom
│ └── ui.ts # Utilities
├── docs/ # Documentation site
├── public/ # Static assets
└── style.css # StylesContribution Areas
Code
- Bug fixes
- New features
- Performance improvements
- Test coverage
Documentation
- Fix typos
- Improve explanations
- Add examples
- Translate to other languages
Design
- UI improvements
- Logo variations
- Social assets
Pull Request Process
- Fork the repository
- Create a feature branch
- Make your changes
- Test thoroughly
- Submit PR with description
PR Guidelines
- Keep changes focused
- Update documentation if needed
- Follow existing code style
- Test on mainnet before submitting
Code Style
- TypeScript strict mode
- No
anytypes where avoidable - Meaningful variable names
- Comments for complex logic
Issues
Found a bug or have an idea?
- Check existing issues
- Open new issue with details
- Use appropriate labels
Security
Found a vulnerability?
Do not open a public issue. Contact us privately via Twitter DM.
License
All contributions are MIT licensed.
