danog/psalm
1
0
Fork 0
mirror of https://github.com/danog/psalm.git synced 2024-11-26 12:24:49 +01:00
Code Issues Projects Releases Wiki Activity

More to contributing docs

Browse Source
This commit is contained in:
Matt Brown 2020-11-30 01:36:12 -05:00 committed by Daniil Gentili
parent 9ce2aeab43
commit 8a4ec20d7f
Signed by: danog
GPG Key ID: 8C1BE3B34B230CA7
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/contributing/index.md
View File

@ -10,6 +10,19 @@ Hopefully you can be one of them?
I've also put together [a list of Psalm’s complexities](what_makes_psalm_complicated.md).
Are you looking for low-hanging fruit? Here are some [GitHub issues](https://github.com/vimeo/psalm/issues?q=is%3Aissue+is%3Aopen+label%3A%22easy+problems%22) that shouldn't be too difficult to resolve.
### Don’t be afraid!
One great thing about working on Psalm is that it’s _very_ hard to introduce any sort of type error in Psalm’s codebase. There are almost 5,000 PHPUnit tests, so the risk of you messing up (without the CI system noticing) is very small.
### Why static analysis is cool
Day-to-day PHP programming involves solving concrete problems, but they're rarely very complex. Psalm, on the other hand, attempts to solve a pretty hard collection of problems, which then allows it to detect a ton of bugs in PHP code without actually executing that code.
There's a lot of interesting theory behind the things Psalm does, too. If you want you can go very deep, though you don't need to know really any theory to improve Psalm.
Lastly, working to improve static analysis tools will also make you a better PHP developer – it'll help you think more about how values flow through your program.
## Pull Requests