Skip to content

Latest commit

 

History

History
88 lines (64 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

88 lines (64 loc) · 3.15 KB

Contributing to rahul-godiyal/php-ups-api-wrapper

Thank you for considering contributing to our rahul-godiyal/php-ups-api-wrapper! We welcome contributions from the community and are grateful for your interest in improving this project.

Table of Contents

  1. How to Contribute
  2. Reporting Bugs
  3. Suggesting Features
  4. Submitting Pull Requests
  5. Development Setup
  6. Code Style
  7. License

How to Contribute

Reporting Bugs

If you find a bug, please open an issue on GitHub. Include as much detail as possible to help us understand and replicate the issue. Information such as the PHP version, the version of the library, and the steps to reproduce the issue are very helpful.

Suggesting Features

We welcome feature suggestions! If you have an idea for a new feature, please open an issue on GitHub with the following details:

  • A clear and descriptive title for the feature.
  • A detailed description of the feature and why it would be useful.
  • Any code examples or API designs, if applicable.

Submitting Pull Requests

Before you start working on a pull request, please open an issue to discuss the change you want to make. This helps us ensure that your contribution is in line with the project's goals and avoids duplicate efforts.

Steps for Submitting a Pull Request:

  1. Fork the Repository: Create a personal fork of the repository on GitHub.
  2. Clone the Fork: Clone your forked repository to your local machine. 
    git clone https://github.com/ragod123/php-ups-api-wrapper.git
  3. Create a Branch: Create a new branch for your work. 
    git checkout -b feature/your-feature-name
  4. Make Changes: Make your changes to the code.
  5. Commit Changes: Commit your changes with a meaningful commit message. 
    git commit -m "Add feature to validate address"
  6. Push Changes: Push your changes to your fork. 
    git push origin feature/your-feature-name
  7. Open a Pull Request: Go to the original repository on GitHub and open a pull request. Provide a clear description of the changes and link to any relevant issues.

Development Setup

To set up a development environment for this project:

  1. Clone the Repository: Clone the repository to your local machine. 
    git clone https://github.com/ragod123/php-ups-api-wrapper.git
  2. Install Dependencies: Install the required dependencies using Composer. 
    composer install
  3. Run Tests: Ensure that all tests pass. 
    ./vendor/bin/phpunit

Code Style

Please follow these guidelines to maintain a consistent code style:

  • Use PSR-12 coding standards.
  • Ensure all code is properly commented.
  • Write meaningful commit messages.
  • Ensure that new features and bug fixes are covered by tests.

License

By contributing to this project, you agree that your contributions will be licensed under the project's MIT License.

Thank you for your contributions! Together, we can make this project better for everyone.