mirror of
https://github.com/danog/file.git
synced 2024-11-30 04:19:39 +01:00
33 lines
1.3 KiB
Markdown
33 lines
1.3 KiB
Markdown
|
## 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. Additionally, please do us all a favor by adhering to the
|
||
|
|
principles of sound bug reporting laid out by Simon Tatham here:
|
||
|
|
|
||
|
|
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
|
||
|
|
|
||
|
|
The amphp project adheres to the PSR-2 style guide with the exception that
|
||
|
|
opening braces for classes and methods must appear on the same line as
|
||
|
|
the declaration:
|
||
|
|
|
||
|
|
https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md
|