diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..600e5fc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# Contributing to DBease + +Thank you for considering contributing to DBease! Contributions from the community help improve and grow this project. Here are some guidelines to get you started. + +## Reporting Issues + +If you encounter a bug or have a feature request, please [open an issue](https://github.com/erikthiart/dbease/issues) on the GitHub repository. When reporting issues, please include as much detail as possible, such as: + +- A clear and concise description of the issue. +- Steps to reproduce the issue. +- Expected and actual behavior. +- Any error messages or logs. + +## Pull Requests + +If you want to contribute code or documentation improvements: + +1. Fork the repository. +2. Create a new branch for your changes: `git checkout -b feature/my-new-feature`. +3. Make your changes and ensure the code follows the existing coding style and conventions. +4. Write unit tests for your code if applicable. +5. Run tests to ensure they pass: `composer test`. +6. Commit your changes: `git commit -m 'Add new feature'`. +7. Push your branch: `git push origin feature/my-new-feature`. +8. Create a pull request on the [GitHub repository](https://github.com/erikthiart/dbease). +9. Provide a clear and concise description of your changes in the pull request. + +## Coding Guidelines + +- Follow the [PSR-12 coding style](https://www.php-fig.org/psr/psr-12/). +- Write clear and concise code with meaningful variable and function names. +- Comment your code when necessary to explain complex logic or functionality. +- Keep your commits and pull requests focused and small in scope. + +## Testing + +Before submitting a pull request, ensure that all tests pass by running: + +```bash +// ToDo