Thank you for considering contributing to Event Shark! We welcome contributions from the community to help improve and enhance the project. This document provides guidelines and best practices for contributing to the project.
If you encounter any issues or have suggestions for improvements, please submit an issue on the GitHub repository. When submitting an issue, please provide as much detail as possible, including steps to reproduce the issue, expected behavior, and any relevant logs or screenshots.
We welcome pull requests for bug fixes, new features, and improvements. To submit a pull request, follow these steps:
- Fork the repository on GitHub.
- Clone your forked repository to your local machine:
git clone https://github.com/your-username/EventShark.git cd EventShark - Create a new branch for your changes:
git checkout -b my-feature-branch
- Make your changes and commit them with a descriptive commit message:
git commit -am "Add new feature" - Push your changes to your forked repository:
git push origin my-feature-branch
- Open a pull request on the original repository and provide a detailed description of your changes.
To ensure consistency and maintainability of the codebase, please adhere to the following coding standards and best practices:
- Follow the existing code style and conventions.
- Write clear and concise code with appropriate comments.
- Ensure your code is well-tested and includes unit tests where applicable.
- Use meaningful variable and function names.
- Avoid introducing unnecessary dependencies.
We are committed to fostering a welcoming and inclusive community. By participating in this project, you agree to abide by our Code of Conduct. Please be respectful and considerate of others in all interactions.
By contributing to Event Shark, you agree that your contributions will be licensed under the MIT License.
Thank you for your contributions and support!