[riot-devel] Pull request procedure

Kaspar Schleiser kaspar at schleiser.de
Fri Aug 21 09:52:47 CEST 2015


Hey,

On 08/20/15 16:46, Oleg Hahm wrote:
> * The provided code and its documentation should make it very clear how this
>   goal is intended to be solved.

This seems like a huge burden to developers writing non-trivial code.
What does "very clear" mean?

Proper reviewing includes reading and understanding the actual code. If
code is unclear, reviewers ask for clarification. Now, apart from a
concept that has been approved, perfect doxygen, commented code, there
needs to be code meta documentation that makes "very clear" how the code
works.

This might speed up PR reviewing, but it slows PR creation. Let's not
lose focus, we want to streamline RIOT development, not PR reviewing.

Kaspar


More information about the devel mailing list