Thank you for considering contributing to this project! We appreciate your interest and support. To ensure a smooth collaboration process, please review and adhere to the following guidelines.
Before starting work on a new feature or bug fix, check the existing issues and pull requests to avoid duplication of efforts. If you find an issue that matches your bug or feature, comment on it to express your interest in working on it. For new issues, provide a clear and concise description with steps to reproduce (if applicable).
Fork the repository and create a branch for your contributions. Give the branch a descriptive name that reflects the purpose of your changes. Make your changes in the branch, following the coding style and best practices outlined in the repository. Ensure that your code is well-documented, including relevant comments and PHPDoc blocks. Commit your changes in logical and atomic units, with clear commit messages explaining the purpose of each commit. Before submitting a pull request, make sure your branch is up to date with the latest changes from the main repository. Clearly describe the purpose and scope of your pull request, providing any necessary context or references.
Follow the coding standards and style guidelines defined by the project. Ensure that your code is clean, readable, and maintainable. Use meaningful variable and function names that accurately describe their purpose. Apply appropriate indentation, spacing, and formatting for improved code readability.
Include unit tests for your changes to maintain code quality and prevent regressions. Make sure all tests pass before submitting a pull request. Add any necessary documentation or instructions related to testing and test coverage.
Update the project documentation as necessary to reflect your changes. Include clear and concise descriptions of new features, changes, or bug fixes. Provide any relevant examples, code snippets, or usage instructions to assist users.
Respect the project's code of conduct, which promotes a friendly, inclusive, and collaborative environment. Be considerate and respectful when interacting with other contributors and users. Report any unacceptable behavior to the project maintainers.
Ensure that your contributions comply with the project's license. If you are introducing new dependencies, make sure they are compatible with the project's license.