[bug #58716] Fix for a typo in reproduce/software/make/python.mk

[Mohammad Akhlaghi]

Update of bug #58716 (project reproduce):

                  Status:             In Progress => Fixed                  
             Open/Closed:                    Open => Closed                 

    _______________________________________________________

Follow-up Comment #4:

Thanks a lot Marius, it has been merged into the core Maneage branch as Commit
c85272705b <http://git.maneage.org/project.git/commit/?id=c85272705b>. 

I just made some small modifications to the first part of the commit message
to be more clear and follow our general standards. We should document them in
the 'README-hacking.md' file, I just haven't had time (so its my fault)! But
after reading this post, if you run 'git log' and look through some of the
latest commits, they should become more natural for you ;-).

The basic idea is that each commit message will be read by people who want to
update their projects by merging into Maneage, so the commit message should
give good context. The other conventions are similar to many other projects.

* The first line of the commit message should not end with a '.'. This is a
very common convention, in many Git-based projects and is based on the idea
that the first line is the commit's title and title don't have '.' in any
editorial standard. Essentially doing a 'git log --oneline' is like looking at
the contents of a book and having a '.' at the end of each line is annoying to
the eye ;-). It also takes valuable space (next point).

* Genenrally, no line in the commit message should be larger than 75
characters (including the title). This helps reading the message in almost any
terminal or terminal emulator: by historical convention, hardly any terminal
is smaller than 80 characters, and git indents the commit message by a few
characters when you run 'git log'. But of course, your commit message was good
in this regard, I am just mentioning it for completenes ;-).

* To help the readers of the commit messages, the first few words of the first
paragraph of the commit message are "Until now ..." or "Until this commit
...". It is followed by a description of the situation until this commit
(which can go on for multiple paragraphs). Following this convention also
encourages the writer to not immediately go into the solution, but describe
the problem first ;-). Later, after the context of the problem is described,
we start a new paragraph that starts with "With this commit ..." and explain
how we solved the problem.

But generally, don't worry about these too much, I will go over all commit
messages before merging and will edit them where necessary to conform with the
convention. The important thing is the code :-).

By the way, in case you would like to stay up to date with the bugs
found/fixed and proposed tasks and join the discussions, you can subscribe to
the reproduce-devel
<https://lists.nongnu.org/mailman/listinfo/reproduce-devel> mailing list ;-).

    _______________________________________________________

Reply to this item at:

  <https://savannah.nongnu.org/bugs/?58716>

_______________________________________________
  Message sent via Savannah
  https://savannah.nongnu.org/