From 8a4ec20d7f6fbf09df4138a546718fc4d39e7c42 Mon Sep 17 00:00:00 2001 From: Matt Brown Date: Mon, 30 Nov 2020 01:36:12 -0500 Subject: [PATCH] More to contributing docs --- docs/contributing/index.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/contributing/index.md b/docs/contributing/index.md index d2c241438..58f51364d 100644 --- a/docs/contributing/index.md +++ b/docs/contributing/index.md @@ -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