|
6 | 6 | description: How to contribute to the Mutates project.
|
7 | 7 | ---
|
8 | 8 |
|
9 |
| -WIP |
| 9 | +# Contributing to Mutates |
| 10 | + |
| 11 | +We're thrilled that you're interested in contributing to Mutates! This document provides guidelines |
| 12 | +and information about how to contribute to our project. |
| 13 | + |
| 14 | +## Getting Started |
| 15 | + |
| 16 | +1. Fork the repository on GitHub. |
| 17 | +2. Clone your fork locally: |
| 18 | + ```bash |
| 19 | + git clone https://github.com/your-username/mutates.git |
| 20 | + cd mutates |
| 21 | + ``` |
| 22 | +3. Install dependencies: |
| 23 | + ```bash |
| 24 | + npm install |
| 25 | + ``` |
| 26 | +4. Create a branch for your contribution: |
| 27 | + ```bash |
| 28 | + git checkout -b feature/your-feature-name |
| 29 | + ``` |
| 30 | + |
| 31 | +## Development Workflow |
| 32 | + |
| 33 | +1. Make your changes in the appropriate package(s). |
| 34 | +2. Write or update tests for your changes. |
| 35 | +3. Ensure all tests pass: |
| 36 | + ```bash |
| 37 | + nx affected --target=test |
| 38 | + ``` |
| 39 | +4. Update documentation if necessary. |
| 40 | +5. Commit your changes with a clear and descriptive commit message. |
| 41 | + |
| 42 | +## Pull Request Process |
| 43 | + |
| 44 | +1. Push your changes to your fork on GitHub. |
| 45 | +2. Open a pull request against the `main` branch of the Mutates repository. |
| 46 | +3. Ensure your PR description clearly describes the problem and solution. |
| 47 | +4. Link any relevant issues in the PR description. |
| 48 | +5. Wait for review from maintainers. |
| 49 | + |
| 50 | +## Coding Standards |
| 51 | + |
| 52 | +- Follow the existing code style in the project. |
| 53 | +- Use TypeScript for new code. |
| 54 | +- Write clear, self-documenting code with appropriate comments where necessary. |
| 55 | +- Ensure your code passes linting: |
| 56 | + ```bash |
| 57 | + nx affected --target=lint |
| 58 | + ``` |
| 59 | + |
| 60 | +## Testing |
| 61 | + |
| 62 | +- Write unit tests for new functionality. |
| 63 | +- Ensure all existing tests pass before submitting a PR. |
| 64 | +- Aim for high test coverage for new code. |
| 65 | + |
| 66 | +## Documentation |
| 67 | + |
| 68 | +- Update relevant documentation for any new features or changes. |
| 69 | +- Use clear and concise language in documentation. |
| 70 | +- Include code examples where appropriate. |
| 71 | + |
| 72 | +## Reporting Issues |
| 73 | + |
| 74 | +- Use the GitHub issue tracker to report bugs or suggest features. |
| 75 | +- Clearly describe the issue, including steps to reproduce for bugs. |
| 76 | +- Check if the issue has already been reported before creating a new one. |
| 77 | + |
| 78 | +## Community and Conduct |
| 79 | + |
| 80 | +- Be respectful and inclusive in all interactions. |
| 81 | +- Follow our [Code of Conduct](CODE_OF_CONDUCT.md). |
| 82 | +- Help others in the community when you can. |
| 83 | + |
| 84 | +## Questions? |
| 85 | + |
| 86 | +If you have any questions about contributing, feel free to open an issue for discussion or reach out |
| 87 | +to the maintainers directly. |
| 88 | + |
| 89 | +Thank you for contributing to Mutates! Your efforts help make this project better for everyone. |
0 commit comments