[Olena-patches] [Olena] #203: Document commit procedures

#203: Document commit procedures ----------------------+----------------------------------------------------- Reporter: levill_r | Owner: levill_r Type: task | Status: new Priority: critical | Milestone: Component: Trac | Version: 1.0 Keywords: | ----------------------+----------------------------------------------------- There are just too many mistakes in commits. The LRDE Guidelines warns about many of them, but IMHO it is not enough. A draft summary: * Read comments from other about your patches (and patch proposals), and take them into account. * Use tools, but don't be fooled by them (know their limits): Vcs, `svn- wrapper`, etc. A flaw in a tool is not an excuse for a dirty patch. * Learn what a (good) !ChangeLog entry is. * Kwow why !ChangeLogs matter (whatever their form), both technically and legally. * Learn how to fix !ChangeLogs correctly. * Resist to the temptation to commit too fast. * Don't break things: run `make` (and possibly `make check`) before committing. * Do not commit too many things at once: one idea/one task = one commit. * Reread you patches before sending them. * Use ispell (when writing documentation). * Learn how to use `git-svn` (or `git`, if it is available) instead of `svn`. * Learn from others: some tools take time to understand and master (Make, Autoconf, Automake, shells, etc.). Olena Teammates shall print and read this page once complete. -- Ticket URL: <https://trac.lrde.org/olena/ticket/203> Olena <http://olena.lrde.epita.fr> Olena, a generic and efficient C++ image processing library.