Re:Ask HN: How can I make your life easier when reviewing a PR?
by greenyoda on Sunday October 23, 2016 @03:11PM
(#12774923)
- Each submission should be a small change that addresses a single issue. It should be easy for the reviewer to understand what you're trying to do.
- Follow the coding conventions established for the project.
- Code quality: factor your code well, use descriptive names, use language-appropriate idioms, etc. The code needs to be easy to understand.
- Make sure you have comments to explain non-obvious things in your code.
- If the project is cross-platform, make sure your code is not dependent on a specific operating system or compiler. If it's web code, make sure it works on browsers other than the one you usually use.
- If it's a new feature (e.g., a new API method), provide documentation for it in the format used by the project.
- Don't gratuitously introduce new dependencies into the project. If the libraries being used have the functionality you need, don't add another library just because you like it better. And don't introduce an entire library just to avoid writing a few lines of code.
- If the reviewer gives you constructive criticism and asks you to re-write your code before they accept it, don't complain about it.
- Perhaps most important: If you have any questions or doubts about what you're doing, ask before submitting the code. It could save both you and the reviewer a lot of wasted effort.
- Follow the coding conventions established for the project.
- Code quality: factor your code well, use descriptive names, use language-appropriate idioms, etc. The code needs to be easy to understand.
- Make sure you have comments to explain non-obvious things in your code.
- If the project is cross-platform, make sure your code is not dependent on a specific operating system or compiler. If it's web code, make sure it works on browsers other than the one you usually use.
- If it's a new feature (e.g., a new API method), provide documentation for it in the format used by the project.
- Don't gratuitously introduce new dependencies into the project. If the libraries being used have the functionality you need, don't add another library just because you like it better. And don't introduce an entire library just to avoid writing a few lines of code.
- If the reviewer gives you constructive criticism and asks you to re-write your code before they accept it, don't complain about it.
- Perhaps most important: If you have any questions or doubts about what you're doing, ask before submitting the code. It could save both you and the reviewer a lot of wasted effort.