Thank you for considering contributing to our open-source project! By contributing, you help make the internet a more accessible and efficient place for everyone. Before you start contributing, please take a moment to read through these guidelines.
- Getting Started
- How to Contribute
- Coding Guidelines
- Commit Message Guidelines
- Branching Strategy
- Code Review Process
- Testing
- Documentation
- Community and Communication
- Code of Conduct
- Acknowledgements
Before you start contributing, make sure you have cloned the repository and installed any necessary dependencies. If you are unsure about anything, feel free to ask for help in our community.
If you find a bug, please open a new issue on our issue tracker with a clear and concise description of the problem. Include steps to reproduce the issue and any relevant error messages.
If you have an idea for an enhancement, open an issue on our issue tracker with a detailed description of your proposal. We welcome any suggestions that improve the functionality, usability, or overall experience of the project.
We welcome code contributions from the community. To contribute:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them with descriptive commit messages.
- Push your changes to your fork.
- Open a pull request, explaining your changes and why they should be merged.
Please follow our coding guidelines when making changes to the codebase. Consistent coding styles help maintain a clean and readable codebase.
Use descriptive commit messages that clearly explain the purpose of your changes. Follow the Conventional Commits specification.
We follow the Gitflow Workflow for branching. Create feature branches for new features and bug branches for fixing issues.
All code changes require review before merging. Collaborate with other contributors and address any feedback received during the review process.
Ensure that your changes include appropriate tests. If you are unsure how to test a specific feature, ask for guidance in the community.
Keep documentation up-to-date with your changes. Documentation is as important as code. If you update or introduce a feature, ensure the documentation reflects those changes.
Join our community to connect with other contributors, ask questions, and stay updated on project developments.
Please review and adhere to our Code of Conduct to ensure a positive and inclusive community for everyone.
Thank you for contributing to our project! Your time and efforts are greatly appreciated.
Happy coding!