1
0
mirror of https://github.com/danog/amp.git synced 2024-12-11 17:09:40 +01:00
amp/CONTRIBUTING.md

42 lines
1.3 KiB
Markdown
Raw Normal View History

2015-07-22 06:24:48 +02:00
## 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](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html).
## 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
2018-06-18 20:00:01 +02:00
The amphp project adheres to the [PSR-2 style guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md
).
2015-07-22 06:24:48 +02:00
2018-06-18 20:00:01 +02:00
To apply code standards you can run `php-cs-fixer` with following composer command:
2018-03-16 14:42:32 +01:00
```bash
composer code-style
```
## Running the tests
2018-03-16 14:55:04 +01:00
Run the test suite from root directory:
2018-03-16 14:42:32 +01:00
```bash
composer test
```