Contributors mailing list archives
Re: Confusion about branch 9.0 in githubby
Camptocamp SA, Guewen Baconnier
On Fri, Nov 13, 2015 at 2:53 PM, Raphaël Valyi <email@example.com> wrote:
On Fri, Nov 13, 2015 at 11:23 AM, <Pedro@pad.odoo-community.org> wrote:Guewen, about that, I know your preference of splitting too much the commits. I give you my opinion about that: I think you should document this with code comments, not with commits, because the end result is the code. If you download on the AppStore a module, you don't have this commit history to see what you want to reflect.I would rephrase it to "If you download on the AppStore a module, you better enjoy watching a Walt Disney movie than attempt to install an open source ERP" ;-)I also think migrations should keep the explanations detailed in the commits regardless of the code comments. Commits can hold much more information than comments. IMHO what is important is enabling the curious developer to find out what has been done during a migration (as Alexandre explained, major version migration is also the unique time window opportunity to break things and do a better design). When you find some strange code, it's also handy to look at git blame (specially on Github) to find possible explanations.
Thanks Raphaël, I couldn't have explained it better.