Open IvanGoncharov opened 4 years ago
FIXME
and stuff that we decided to implement latter with TODO
ideally they should contain a link to either GitHub issue or link to PR comment.git add -p
or review diff that GitHub shows you before you create PR. You should be able to explain to yourself every change that you made. A good reviewer will do the same but by doing it yourself you will save a lot of time for both parties.
We have a pretty uniform codebase which is very important for the reference implementation. That said I the price that we pay for this it's extremely hard to start contributing since you get a huge amount of review comments in your first PR. Also, it gave the wrong incentives to maintainers (including myself) to just rewriting PR from scratch since it was way easier than to explain what's wrong with the code.
Don't think that there is any silver bullet but we can do a couple of things:
CONTRIBUTION.md
I think a good strategy would be to first work on common issues that most of the first-time contributors struggling with:
index.js
and one of the top level folders