Minh Nguyen wrote: > Hi Leif, > > On Wed, Oct 27, 2010 at 6:57 AM, leif <not.rea...@online.de> wrote: >> http://www.sagemath.org/doc/developer/walk_through.html#submitting-a-change >> >> does not even mention one can use longer commit messages. ("hg log" >> only shows the first line, while "hg log -v" shows the full commit >> message, along with the files modified by a changeset.) > > I envision the walk-through to be a first required reading for any > (new) Sage contributor. This means that one should be able to read > through it in about an hour (more or less) and absorb the important > information. A new contributor should not be exposed to too much > information or details about Mercurial, Sage development guidelines, > coding guidelines, etc. on a first or second reading of the > walk-through. That's the job of the other chapters following the > walk-through. For further explanatory information, the walk-through > should provide links to other chapters or sections in the Developer's > Guide that contain that related information. For example, for advanced > Mercurial tips/tricks on working with the Sage library, there could be > a section outside of the walk-through devoted to this. If you open a > ticket and upload something along this line, I promise to review it > this weekend. Otherwise, I could write something and upload a patch > during this weekend.
Yes. It's just that it currently sounds like "one *must not* use commit messages exceeding one line". Of course the first line should be a brief summary (and shouldn't be [much] longer than 80 characters), but we could add a note there that longer descriptions *below* are welcome. Cheers, -Leif -- To post to this group, send an email to sage-devel@googlegroups.com To unsubscribe from this group, send an email to sage-devel+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/sage-devel URL: http://www.sagemath.org
