|
| 1 | +# Contributing to Cleanenv |
| 2 | + |
| 3 | +Thank you for your interest in contributing to Cleanenv! |
| 4 | + |
| 5 | +## How to Contribute |
| 6 | + |
| 7 | +Contributions can take many forms, including bug reports, feature requests, documentation improvements, and code changes. We welcome all contributions that align with the goals of the project. |
| 8 | + |
| 9 | +Please keep in mind that this project is designed to be minimalistic, obvious, and as simple as possible. |
| 10 | +We prioritize clear and easy-to-understand code over complex or "magical" solutions. |
| 11 | +If you're considering making a code change that might be considered overcomplicated or not in line with the project's goals, |
| 12 | +we recommend opening an issue to discuss the change before submitting a pull request. |
| 13 | + |
| 14 | +### Reporting Bugs and Requesting Features |
| 15 | + |
| 16 | +If you've found a bug or have an idea for a new feature, please open an issue on our GitHub repository. Be sure to include as much detail as possible, including steps to reproduce the issue, expected behavior, and actual behavior. |
| 17 | + |
| 18 | +### Contributing Code Changes |
| 19 | + |
| 20 | +If you would like to contribute code changes to the project, please follow these steps: |
| 21 | + |
| 22 | +1. Fork the repository to your own GitHub account. |
| 23 | +2. Create a new branch for your changes. |
| 24 | +3. Make your changes and test them thoroughly. |
| 25 | +4. Submit a pull request (PR) with your changes. |
| 26 | +5. Wait for a project maintainer to review your PR. The review process may take some time, so please be patient. |
| 27 | +6. Respond to any feedback and make any necessary changes to your code. |
| 28 | +7. Once your PR has been approved, it will be merged into the main branch of the repository. |
| 29 | + |
| 30 | +### Code Style and Standards |
| 31 | + |
| 32 | +Try to stick to the existing code style of the project. |
| 33 | + |
| 34 | +### Testing |
| 35 | + |
| 36 | +We rely on unit tests to ensure the quality of our code. |
| 37 | +Before submitting a PR, please make sure your changes include appropriate tests. |
| 38 | +The number indicating the test code coverage should not decrease. |
| 39 | + |
| 40 | +## Getting Help |
| 41 | + |
| 42 | +If you need help with the project, please don't hesitate to ask. |
| 43 | +You can get in touch with the project maintainers by opening an issue on the GitHub repository. |
0 commit comments