Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 2.75 KB

CONTRIBUTION_GUIDELINES.md

File metadata and controls

59 lines (41 loc) · 2.75 KB
Raw

Contribution Guidelines

We welcome and appreciate contributions to the WPRestClient project. To ensure a smooth and collaborative process, please take a moment to review the following guidelines.

Code of Conduct

Please familiarize yourself with our Code of Conduct to understand the expected behavior and conduct within our project community.

Ways to Contribute

There are several ways you can contribute to WPRestClient:

  1. Reporting Issues: If you come across any bugs, issues, or have feature requests, please open an issue on our GitHub repository and provide a detailed description.

  2. Bug Fixes and Enhancements: You can contribute by fixing bugs or enhancing existing features. Fork the repository, make your changes in a new branch, and submit a pull request.

  3. Documentation: Improvements to documentation are highly appreciated. If you notice any areas that need clarification or have suggestions for better explanations, feel free to submit a pull request.

  4. Testing: Help improve the reliability and stability of the library by writing and running tests. Contributions that include new test cases or improve test coverage are valuable.

Getting Started

  1. Fork the repository to your GitHub account.

  2. Clone the forked repository to your local development environment.

  3. Install the project dependencies by running the following command:

    composer install

  4. Make your changes, additions, or fixes in a new branch, ensuring clear and concise commit messages.

  5. Test your changes thoroughly to ensure they don't introduce new issues.

  6. Push your changes to your forked repository.

  7. Submit a pull request to the main branch of the WPRestClient repository. Provide a detailed description of your changes and the problem they solve.

Pull Request Guidelines

  • Follow the coding style and conventions used in the project.
  • Provide a clear and descriptive title for your pull request.
  • Include a detailed description of the changes and the problem they address.
  • Reference any related issues or pull requests in your description using the appropriate GitHub syntax (e.g., "#123").
  • Ensure your code passes all existing tests, and if applicable, include new tests for your changes.
  • Be responsive to feedback and comments during the review process.

License

By contributing to WPRestClient, you agree that your contributions will be licensed under the MIT License.

We appreciate your valuable contributions to the project! Thank you for helping us improve WPRestClient and make it even better.

If you have any questions or need further assistance, feel free to reach out to [email protected]