src
1 year ago
CONTRIBUTING.md
1 year ago
LICENSE
2 years ago
README.md
1 year ago
composer.json
1 year ago
composer.lock
1 year ago
phpcs-ruleset.xml
3 years ago
phpunit.xml
2 years ago
CONTRIBUTING.md
62 lines
| 1 | # Contributing to apimatic/core-lib-php |
| 2 | |
| 3 | Thank you for your interest in contributing! 🎉 Your contributions help make this project better. We value open-source contributions to this library, please take a few minutes to review this guide before you start. |
| 4 | |
| 5 | --- |
| 6 | |
| 7 | ## 💡 How to Contribute |
| 8 | |
| 9 | ### 📌 1. Reporting Issues |
| 10 | |
| 11 | - Search existing issues before opening a new one. |
| 12 | - Use a **descriptive title** and provide clear steps to reproduce. |
| 13 | - Include relevant logs, screenshots, or error messages. |
| 14 | |
| 15 | ### 🔧 2. Making Changes |
| 16 | |
| 17 | #### Step 1: Create a Branch |
| 18 | |
| 19 | - Create a new branch from `master`: |
| 20 | ```sh |
| 21 | git checkout -b your-feature-name |
| 22 | ``` |
| 23 | |
| 24 | #### Step 2: Make Your Changes |
| 25 | |
| 26 | - Follow the project's **coding standards**. |
| 27 | - Add **unit tests** if applicable. |
| 28 | - Ensure your changes **do not break existing functionality**. |
| 29 | |
| 30 | #### Step 3: Commit Changes |
| 31 | |
| 32 | - Use clear and descriptive commit messages: |
| 33 | ```sh |
| 34 | git commit -m "feat: Add feature description" |
| 35 | ``` |
| 36 | |
| 37 | #### Step 4: Push & Open a PR |
| 38 | |
| 39 | - Push your branch: |
| 40 | ```sh |
| 41 | git push origin your-feature-name |
| 42 | ``` |
| 43 | - Open a **Pull Request (PR)** on GitHub: |
| 44 | - Provide a clear **description** of the changes. |
| 45 | - Mention related **issue numbers**. |
| 46 | - Request a **review** from maintainers. |
| 47 | - Make sure your changes clear all the **PR Checks**. |
| 48 | |
| 49 | --- |
| 50 | |
| 51 | ## 📜 License |
| 52 | |
| 53 | By contributing, you agree that your contributions will be licensed under the project's [](LICENSELICENSE](LICENSE](LICENSE). |
| 54 | |
| 55 | --- |
| 56 | |
| 57 | 💬 **Questions?** |
| 58 | If you need help, feel free to open issues, we will be happy to help. |
| 59 | |
| 60 | Happy Coding! 🚀 |
| 61 | |
| 62 |