[gnuastro-devel] [task #14289] Adding bug/task fixed/completed when merging with master

[Mohammad Akhlaghi]

URL:
  <http://savannah.gnu.org/task/?14289>

                 Summary: Adding bug/task fixed/completed when merging with
master
                 Project: GNU Astronomy Utilities
            Submitted by: makhlaghi
            Submitted on: Tue 27 Dec 2016 12:09:27 AM JST
         Should Start On: Mon 26 Dec 2016 12:00:00 AM JST
   Should be Finished on: Mon 26 Dec 2016 12:00:00 AM JST
                Category: Development
                Priority: 5 - Normal
              Item Group: Enhancement
                  Status: Need Info
                 Privacy: Public
        Percent Complete: 0%
             Assigned to: makhlaghi
             Open/Closed: Open
         Discussion Lock: Any
                  Effort: 0.00

    _______________________________________________________

Details:

In the current Commit guidelines
<https://www.gnu.org/software/gnuastro/manual/html_node/Commit-guidelines.html>,
we have asked for commiters to include a statement at the the end of the
commit message saying  ‘This fixes bug #ID.’, or ‘This finishes task
#ID.’. 

This makes things complicated when submitting a new bug/task issue with a link
to the branch with the fix: since you don't have the bug/task number. So the
solution was to first define the bug/task, use its number in the commit
message, push the branch and then include the link. This is inconvenient.

I wanted to bring up a solution to this here for discussion: I can add these
statements to the commit (through `git commit --amend') after merging it with
the master branch. All the commit information (author, dates, and etc) will
remain unchanged, only the commit body will be changed. This way, the initial
bug/task report can also contain a link to the fix and if the commit needs
further work, others can easily work based on it, without worrying about an
immature statement (in complicated cases): only after it is merged with master
will this statement be added.

If you have any ideas/suggestions, please share them here, we can start this
convention with the 0.3 release.




    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/task/?14289>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/