Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 29 additions & 19 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -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/<username>/<repo>.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!
Loading