From eb624428f5a0bf8f48b06050dbb579acd9c7e7e7 Mon Sep 17 00:00:00 2001 From: francesco Date: Wed, 18 Mar 2026 16:03:51 +0100 Subject: [PATCH] docs(contributing): improve contributing guide clarity and completeness Co-Authored-By: Claude Sonnet 4.6 --- docs/contributing.md | 48 ++++++++++++++++++++++++++------------------ 1 file changed, 29 insertions(+), 19 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index c638d0a..707911d 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,45 +1,55 @@ -# Contributing to Openapi SDK +# Contributing to Openapi PHP SDK -Thanks for considering contributing! 🎉 -We welcome all kinds of contributions: bug reports, feature requests, documentation improvements, and code enhancements. +Thanks for considering contributing! We welcome all kinds of contributions: bug reports, feature requests, documentation improvements, and code enhancements. ## How to Contribute 1. **Fork the repository** and clone it locally: ```bash - git clone https://github.com//.git + git clone https://github.com/openapi/openapi-php-sdk.git ``` -2. **Create a branch** for your feature or fix: +2. **Install dependencies:** + ```bash + composer install + ``` + +3. **Create a branch** for your feature or fix: ```bash git checkout -b feature/your-feature-name ``` - -3. **Make your changes** and commit them: + +4. **Make your changes** and run the tests: + ```bash + ./vendor/bin/phpunit tests/ + ``` + +5. **Commit your changes:** ```bash git commit -m "Add some feature" ``` - -4. **Push your branch** to your fork: + +6. **Push your branch** to your fork: ```bash git push origin feature/your-feature-name ``` - -5. **Open a Pull Request** describing your changes. + +7. **Open a Pull Request** describing your changes. ## Guidelines -* Follow the existing **Php coding style**. -* Include **tests** for new features or bug fixes when applicable. -* Keep **commit messages clear and concise**. -* Update **documentation** as needed for your changes. +- Follow the existing **PHP coding style** (PHP 8.0+). +- Include **tests** for new features or bug fixes when applicable. +- Keep **commit messages clear and concise**. +- Write all code, comments, and documentation in **English**. +- Update **documentation** as needed for your changes. ## Reporting Issues To report bugs or request features, please **open an issue** on GitHub including: -* Clear description of the problem or feature. -* Steps to reproduce (if applicable). -* Relevant logs or screenshots. +- A clear description of the problem or feature. +- Steps to reproduce (if applicable). +- Relevant logs or error output. -Thank you for helping improve Openapi SDK! 🚀 +Thank you for helping improve the OpenAPI PHP SDK!