Skip to content

Latest commit

 

History

History
38 lines (23 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

38 lines (23 loc) · 2.08 KB

Contributing Guide

Thank you for considering contributing to the RESTPresenter package!

License

The RESTPresenter package is open-sourced software licensed under the MIT license.

Reporting Issues

If you believe you have found a bug, please report it using the GitHub issue tracker

Submitting a Pull Request

We welcome and appreciate all contributions. Here are the steps to submit a pull request:

  1. Fork rest-presenter repository on GitHub - uncheck Copy the main branch only
  2. Clone forked repository locally - git clone https://github.com/xtend-packages/rest-presenter
  3. Create new branch from the develop branch - git checkout -b feature/your-feature-name
  4. Implement your code in your branch and please follow the follow the conventional commits standards
  5. Write at least 1-2 tests for your code using PEST PHP testing framework
  6. Run the tests make sure they all pass if not reach out for help on Discord
  7. Create a pull request to our develop branch in the rest-presenter repository
  8. Wait for your pull request to be reviewed and hopefully merged

Thank you for your contribution!

Coding Standards

This package follows strict coding standards. Please make sure to include at least one test for each new feature you add. If you are unsure how to write a test, please ask for help. We are here to help you contribute to the package. One of our workflows on GitHub will automatically check your code style and run the tests. It will automatically fix code style issues and auto-commit to your open pull request.ease ask for help.

Security Vulnerabilities

If you discover a security vulnerability within the RESTPresenter package, please notify us either on Discord or raise an issue on GitHub. All security vulnerabilities will be dealt with promptly.

Thank you

We appreciate your help with the RESTPresenter package. We are excited to collaborate with you and the community to make this package even better!