|
| 1 | +# Contributing to Evolution SDK |
| 2 | + |
| 3 | +We love your input! We want to make contributing to Evolution SDK as easy and transparent as possible, whether it's: |
| 4 | + |
| 5 | +- Reporting a bug |
| 6 | +- Discussing the current state of the code |
| 7 | +- Submitting a fix |
| 8 | +- Proposing new features |
| 9 | +- Becoming a maintainer |
| 10 | + |
| 11 | +## Development Process |
| 12 | + |
| 13 | +We use GitHub to host code, to track issues and feature requests, as well as accept pull requests. |
| 14 | + |
| 15 | +### Pull Requests |
| 16 | + |
| 17 | +1. Fork the repo and create your branch from `main`. |
| 18 | +2. If you've added code that should be tested, add tests. |
| 19 | +3. If you've changed APIs, update the documentation. |
| 20 | +4. Ensure the test suite passes. |
| 21 | +5. Make sure your code follows the existing style. |
| 22 | +6. Issue that pull request! |
| 23 | + |
| 24 | +## Development Setup |
| 25 | + |
| 26 | +```bash |
| 27 | +# Clone your fork |
| 28 | +git clone https://github.com/your-username/evolution-sdk.git |
| 29 | +cd evolution-sdk |
| 30 | + |
| 31 | +# Enter development environment (optional but recommended) |
| 32 | +nix develop |
| 33 | + |
| 34 | +# Install dependencies |
| 35 | +pnpm install |
| 36 | + |
| 37 | +# Build the project |
| 38 | +pnpm turbo build |
| 39 | + |
| 40 | +# Run type checking |
| 41 | +pnpm turbo type-check |
| 42 | + |
| 43 | +# Start development mode |
| 44 | +pnpm turbo dev |
| 45 | +``` |
| 46 | + |
| 47 | +## Code Style |
| 48 | + |
| 49 | +- Use TypeScript for all new code |
| 50 | +- Follow the existing code style (we use prettier and eslint) |
| 51 | +- Write meaningful commit messages |
| 52 | +- Keep pull requests focused and small |
| 53 | + |
| 54 | +## Reporting Bugs |
| 55 | + |
| 56 | +We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/no-witness-labs/evolution-sdk/issues/new). |
| 57 | + |
| 58 | +**Great Bug Reports** tend to have: |
| 59 | + |
| 60 | +- A quick summary and/or background |
| 61 | +- Steps to reproduce |
| 62 | + - Be specific! |
| 63 | + - Give sample code if you can |
| 64 | +- What you expected would happen |
| 65 | +- What actually happens |
| 66 | +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) |
| 67 | + |
| 68 | +## Feature Requests |
| 69 | + |
| 70 | +Feature requests are welcome! Please create an issue to discuss the feature before implementing it. |
| 71 | + |
| 72 | +## License |
| 73 | + |
| 74 | +By contributing, you agree that your contributions will be licensed under the MIT License. |
0 commit comments