Menu

Comments about changes in code....

Soren Bro
2019-03-12
2019-03-12
  • Soren Bro

    Soren Bro - 2019-03-12

    Normally one would write in the top of the file you edit, who you are and
    when you did what.

    Sometimes thuogh, a solution spans several such files and piecing the logic
    together can be a pain.

    I propose therefore that we use TODO.txt (or perhaps a dedicated one for
    this purpose) so we can explain a mutiple file edit with a single logical
    explanation.

    Just a heads up about where you'd be able to find an explanation for
    seemingly unrelated edit events....

    Regards.
    Søren

     
    • Ted Matavka

      Ted Matavka - 2019-03-12

      On Tuesday, March 12, 2019 6:25:20 AM EDT, Soren Bro wrote:

      Normally one would write in the top of the file you edit, who you are and
      when you did what.

      Yes, that's about right.

      Sometimes thuogh, a solution spans several such files and piecing the logic
      together can be a pain.

      This is what a "commit message" is for.

      I propose therefore that we use TODO.txt (or perhaps a dedicated one for
      this purpose) so we can explain a mutiple file edit with a single logical
      explanation.

      Denied. The best way to do this is when committing the code. When you do
      an hg addremove; hg commit, Mercurial launches an editor, and that's where
      you put a summary of your changes. This is actually very important and I'm
      glad you brought it up. Nobody---and I do mean nobody---on this project is
      irreplaceable.

      Just a heads up about where you'd be able to find an explanation for
      seemingly unrelated edit events....

      Thanks.

      Regards.
      Søren

      Comments about changes in code....

      Sent from sourceforge.net because you indicated interest in
      https://sourceforge.net/p/hermesmail/discussion/general/

      To unsubscribe from further messages, please visit
      https://sourceforge.net/auth/subscriptions/

       

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.