-
Notifications
You must be signed in to change notification settings - Fork 38.8k
Remove file and class order guidelines #5201
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
Ah yes, I was intending to do this for a while. ACK. |
|
I think even with this we should split up the review of difficult pulls into two phases:
|
|
ACK |
|
Fell free to do that, I just think it's anoying to make such nits for core devs anyway. If all would use this convention, it wouldn't even cause the need for a "cleanup phase" nor the need for such a pull ;). It's also likely that not many will ever contribute to such a cleanup phase... if the intention is: "Please Dia don't always "spam" our pulls with nits!" I'm fine with that, but will rethink my motivation to improve code quality (style wise ^^) for this project. |
|
ACK. Please Dia don't always spam our pulls with nits. |
Remove file and class order guidelines
|
@Diapolo Yes, if everyone would keep exactly to the convention. But we're human, not robots (ok, speaking just for me). While thinking deeply about how code and data structures should work, reordering and writing new code, it's easy to make a stylistic "mistake" here and there. Focusing too much on them is distracting. This is true during review as well. I'm not sure how to handle this better - the two-phase approach is just a proposal that may not actually work either - but 'Please Dia don't always spam our pulls with nits' sounds good to me for now. |
|
Indeed. Referencing the Linux kernel, there were periodic cleanup patches from "janitors" who are typically just entering the codebase / learning the code. This is better than nagging on every PR. |
|
At Google there were very strict rules about ordering of includes etc, and this worked well. But that was with automatic tools for reordering, and their code-review tool would tell you about this immediately (and many more things), so it was much easier to make sure that everybody always knows and used the same system. Here we tried, and I don't think the benefits are worth the effort. |
These cause too much nagging that make comments about correctness go lost in the noise.