Skip to content

Contribution Guide

Guidelines for contributing to Shopper

Contributions are accepted via Pull Requests on GitHub.

Bug Reports

To encourage active collaboration, Shopper strongly encourages pull requests, not just bug reports. "Bug reports" may also be sent in the form of a pull request containing a failing test.

Pull Requests

  • Add tests - A pull request that changes behaviour comes with tests that cover it.
  • Document any change in behaviour - Make sure the readme.md and any other relevant documentation are kept up-to-date.
  • Consider our release cycle - Shopper follows SemVer v2.0.0: minor and patch releases never contain breaking changes.
  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.
  • Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

Happy coding!

Security Vulnerabilities

If you discover a security vulnerability within Shopper, report it privately through GitHub or by email at arthur@shopperlabs.co. Do not open a public issue. All security vulnerabilities will be promptly addressed.

Coding Style

Shopper follows the Laravel coding style, checked by Laravel Pint with the rules in pint.json, and the PSR-4 autoloading standard. Run composer lint to format your changes before you push them.

Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. We are committed to making participation in this project a harassment-free experience for everyone, regardless of the level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion. Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.

Last updated on

Edit on GitHub