From 7e9ac09d4a0a94c97b8c106ab4c3bc33e26f1655 Mon Sep 17 00:00:00 2001 From: Charles Prado Date: Fri, 15 Sep 2023 19:32:28 +0100 Subject: [PATCH] Added CONTRIBUTING.md --- CONTRIBUTING.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cfba88c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,46 @@ +# Contribution Guidelines + +Thank you for considering contributing to this project! Contributions from the community are welcome to help improve and grow this project. Please take a moment to review this document before getting started. + +## How Can You Contribute? + +There are several ways to contribute to this project: + +1. **Bug Reporting:** If you encounter a bug or an issue with the project, please open a new issue in the GitHub issue tracker. Provide a detailed description of the problem, including steps to reproduce it if possible. + +2. **Feature Requests:** If you have ideas for new features or improvements, feel free to open an issue to discuss them. Your input on how to make the project better is appreciated. + +3. **Code Contributions:** If you're a developer and want to contribute code, you can fork the repository, create a branch for your work, and submit your changes directly. + +## Code Contributions + +Here's how you can contribute code to the project: + +1. Fork the repository to your GitHub account. + +2. Clone your forked repository to your local development environment. + +3. Create a new branch for your work: `git checkout -b feature/your-feature-name` or `bugfix/your-bugfix-name`. + +4. Make your changes and ensure your code follows the coding style. + +5. Write tests for your code if applicable and ensure all existing tests pass. + +6. Commit your changes with a clear and descriptive commit message. + +7. Push your branch to your GitHub repository: `git push origin feature/your-feature-name`. + +8. Open a direct contribution against the `main` branch of this repository. Provide a detailed description of your changes and why they should be merged. + +9. Your direct contribution will be reviewed by the maintainers, and any necessary feedback will be provided. + +10. Once your contribution is approved, it will be merged into the `main` branch, and your contribution will be credited. + +## License + +By contributing to this project, you agree that your contributions will be licensed under the project's [MIT License](LICENSE). + +## Questions and Feedback + +If you have questions or need clarification on anything related to contributing, feel free to reach out by [creating an issue](https://github.com/chrsp/AnimatedAlert/issues) or [contacting me](mailto:chrspx@gmail.com). +