1
0
mirror of https://github.com/danog/template.git synced 2024-11-26 12:04:49 +01:00
template/CONTRIBUTING.md
2019-08-22 23:52:44 +02:00

1.3 KiB

Submitting useful bug reports

Please search existing issues first to make sure this is not a duplicate. Every issue report has a cost for the developers required to field it; be respectful of others' time and ensure your report isn't spurious prior to submission. Please adhere to sound bug reporting principles.

Development ideology

Truths which we believe to be self-evident:

  • It's an asynchronous world. Be wary of anything that undermines async principles.

  • The answer is not more options. If you feel compelled to expose new preferences to the user it's very possible you've made a wrong turn somewhere.

  • There are no power users. The idea that some users "understand" concepts better than others has proven to be, for the most part, false. If anything, "power users" are more dangerous than the rest, and we should avoid exposing dangerous functionality to them.

Code style

The amphp project adheres to the PSR-2 style guide.

To apply code standards you can run php-cs-fixer with following composer command:

composer code-style

Running the tests

Run the test suite from root directory:

composer test