Contributing
Contributing to Veil.
Getting Started
- Fork the repository
- Clone your fork
- Create a branch
git checkout -b feature/your-featureDevelopment Setup
Prerequisites
- Node.js 18+
- Rust & Anchor
- Solana CLI
- PostgreSQL (for coordinator)
Install Dependencies
# Program
cd program && yarn install
# SDK
cd ../sdk && yarn install
# Coordinator
cd ../coordinator && yarn install
# Examples
cd ../examples && yarn installBuild
# Program
cd program && anchor build
# SDK
cd ../sdk && yarn build
# Coordinator
cd ../coordinator && yarn buildCode Style
- Rust: Follow standard Rust conventions
- TypeScript: Use ESLint and Prettier
- Commits: Use conventional commits
Testing
Program Tests
cd program
anchor testSDK Tests
cd sdk
yarn testIntegration Tests
cd examples
yarn 05-full-flowPull Requests
- Update documentation if needed
- Add tests for new features
- Run tests before submitting
- Write clear commit messages
Documentation
- Update relevant docs in
/docs - Add examples for new features
- Update API reference
Reporting Issues
- Use GitHub Issues
- Include reproduction steps
- Provide error messages/logs
Code of Conduct
- Be respectful
- Welcome newcomers
- Focus on constructive feedback