Skip to content

Latest commit

 

History

History
38 lines (20 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

38 lines (20 loc) · 1.97 KB
Raw

Contributing to QuantumForms

Projects like the QuantumForms survive by contributions from brilliant coders around the world. Keeping this in mind, we wanted to make the process as easy as possible.

All contributions must be submitted via a Pull Request on GitHub.

Pull Requests

  • PSR-4 Coding Standard - In order to comply with this standard, you should run PHP Code Sniffer as you write.

  • Add tests - If you've added code that can be tested, add tests.

  • Document any change in behavior - Make sure the README and any associated documentation is kept up to date.

  • Create topic branches - Don't ask us to pull from your master branch. Ever.

  • 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.

  • Ensure tests pass! - Please run the tests before submitting your pull request, and make sure they pass. We won't accept a patch until all tests pass.

  • Ensure no coding standards violations - Please run PHP Code Sniffer using the PSR-4 standard before submitting your pull request. A violation will cause the build to fail, so please make sure there are no violations. We can't accept a patch if the build fails.

Issues

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Running Tests

All tests must pass in order for your contribution to be accepted. This is to protect the codebase, and ensure a quality product.

$ phpunit -c tests

Happy coding!