-
-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ec56996
commit b533029
Showing
1 changed file
with
51 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Contributing to Ninjemail | ||
|
||
Thank you for considering contributing to Ninjemail! This document provides guidelines on how to contribute to this project. | ||
|
||
### Setting Up Your Development Environment | ||
|
||
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. | ||
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. | ||
3. **Project installation**: Follow the project [installation steps](https://github.com/david96182/ninjemail?tab=readme-ov-file#installation). | ||
|
||
## Issue Reporting | ||
|
||
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: | ||
|
||
- Provide a clear and descriptive title. | ||
- Describe the issue in as much detail as possible. | ||
- Include steps to reproduce the issue. | ||
- Mention the configuration of the project you're using. | ||
|
||
## Pull Requests | ||
|
||
If you've made changes that you'd like to contribute back to the project, you can open a pull request. Here's how: | ||
1. **Fork the Repository**: If you haven't already, fork the repository. | ||
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. | ||
3. **Commit Your Changes**: Commit your changes with a clear and descriptive commit message. | ||
4. **Push Your Changes**: Push your changes to your forked repository. | ||
5. **Open a Pull Request**: Go to your forked repository on GitHub and click on the "New pull request" button. | ||
|
||
## Code Style | ||
|
||
When contributing code, please follow the project's code style. This might include: | ||
|
||
- Indentation and spacing | ||
- Naming conventions | ||
- Comment style | ||
|
||
## Testing | ||
|
||
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. | ||
|
||
## Documentation | ||
|
||
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. | ||
|
||
## License | ||
|
||
By contributing to Ninjemail, you agree that your contributions will be licensed under its [LICENSE](LICENSE). | ||
|
||
--- | ||
|
||
Thank you for contributing to [Your Project Name]! We look forward to your contributions. |