|
| 1 | +# Contributing to Ninjemail |
| 2 | + |
| 3 | +Thank you for considering contributing to Ninjemail! This document provides guidelines on how to contribute to this project. |
| 4 | + |
| 5 | +### Setting Up Your Development Environment |
| 6 | + |
| 7 | +1. **Fork the Repository**: Go to the [project repository](https://github.com/david96182/ninjemail) and click on the "Fork" button at the top right corner. This will create a copy of the repository in your GitHub account. |
| 8 | +2. **Clone Your Fork**: Clone your forked repository to your local machine. Replace `yourusername` with your GitHub username and `yourproject` with the name of your project. |
| 9 | +3. **Project installation**: Follow the project [installation steps](https://github.com/david96182/ninjemail?tab=readme-ov-file#installation). |
| 10 | + |
| 11 | +## Issue Reporting |
| 12 | + |
| 13 | +If you find a bug or have a feature request, please open an issue on the [issue tracker](https://github.com/david96182/ninjemail/issues). When filing an issue, make sure to: |
| 14 | + |
| 15 | +- Provide a clear and descriptive title. |
| 16 | +- Describe the issue in as much detail as possible. |
| 17 | +- Include steps to reproduce the issue. |
| 18 | +- Mention the configuration of the project you're using. |
| 19 | + |
| 20 | +## Pull Requests |
| 21 | + |
| 22 | +If you've made changes that you'd like to contribute back to the project, you can open a pull request. Here's how: |
| 23 | +1. **Fork the Repository**: If you haven't already, fork the repository. |
| 24 | +2. **Create a New Branch**: Create a new branch for your changes. It's a good practice to name your branch according to the issue you're addressing. |
| 25 | +3. **Commit Your Changes**: Commit your changes with a clear and descriptive commit message. |
| 26 | +4. **Push Your Changes**: Push your changes to your forked repository. |
| 27 | +5. **Open a Pull Request**: Go to your forked repository on GitHub and click on the "New pull request" button. |
| 28 | + |
| 29 | +## Code Style |
| 30 | + |
| 31 | +When contributing code, please follow the project's code style. This might include: |
| 32 | + |
| 33 | +- Indentation and spacing |
| 34 | +- Naming conventions |
| 35 | +- Comment style |
| 36 | + |
| 37 | +## Testing |
| 38 | + |
| 39 | +If your contribution includes code changes, please include tests that cover your changes. This helps ensure that your changes work as expected and don't introduce new issues. |
| 40 | + |
| 41 | +## Documentation |
| 42 | + |
| 43 | +If your contribution includes new features or changes to existing features, please update the documentation accordingly. This includes the README files and any other relevant documentation. |
| 44 | + |
| 45 | +## License |
| 46 | + |
| 47 | +By contributing to Ninjemail, you agree that your contributions will be licensed under its [LICENSE](LICENSE). |
| 48 | + |
| 49 | +--- |
| 50 | + |
| 51 | +Thank you for contributing to [Your Project Name]! We look forward to your contributions. |
0 commit comments