Commit message guidelines: Difference between revisions

→‎Examples: Update punctuation to GNU style
(→‎Examples: Update punctuation to GNU style)
 
(3 intermediate revisions by 2 users not shown)
Line 10: Line 10:


<pre>
<pre>
look for methods before constructors
Look for methods before constructors.


* symtab.cc (symbol_table::fcn_info::fcn_info_rep::find):
* symtab.cc (symbol_table::fcn_info::fcn_info_rep::find):
Line 22: Line 22:


<pre>
<pre>
allow abbreviations for optimset and optimget (bug #38999)
Allow abbreviations for optimset and optimget (bug #38999).


* optimset.m, optimget.m: Handle abbreviated keys and warn for
* optimset.m, optimget.m: Handle abbreviated keys and warn for
Line 29: Line 29:


<pre>
<pre>
add format option to ticklabel (bug #34906)
Add format option to ticklabel (bug #34906).


* graphics.cc: add new functions to support different input arguments to
* graphics.cc: Add new functions to support different input arguments to
   xyzticklabel. Add tests.
   xyzticklabel. Add tests.
* graphics.in.h: define set_xyzticklabel as external function
* graphics.in.h: Define set_xyzticklabel as external function.
</pre>
</pre>


<pre>
<pre>
tag symbols in indexed assignments as variables (bug #39240)
Tag symbols in indexed assignments as variables (bug #39240).


* pt-arg-list.cc (tree_argument_list::variable_names): Also return the
* pt-arg-list.cc (tree_argument_list::variable_names): Also return the
Line 45: Line 45:


<pre>
<pre>
tar, untar, unpack: Add support for BSD tar (bug #53695)
tar, untar, unpack: Add support for BSD tar (bug #53695).


* tar_is_bsd.m: New function.
* tar_is_bsd.m: New function.
Line 56: Line 56:
This examples are the rare cases where only one file is modified and the change is simple enough:
This examples are the rare cases where only one file is modified and the change is simple enough:


  maint: merge stable to default.
  maint: Merge stable to default.
   
   
  maint: merge away accidental head.
  maint: Merge away accidental head.
   
   
  maint: Strip trailing whitespace from source files.
  maint: Strip trailing whitespace from source files.
Line 64: Line 64:
  maint: Update gnulib to latest changes.
  maint: Update gnulib to latest changes.
   
   
  doc: grammarcheck documentation for 4.2 release.
  doc: Grammarcheck documentation for 4.2 release.
   
   
  pkg.m4: update to lastest version as released with pkg-config 0.29 (bug #48775)
  pkg.m4: Update to latest version as released with pkg-config 0.29 (bug #48775).
   
   
  uigetfile.m: allow path names as input arg (bug #48828)
  uigetfile.m: Allow path names as input arg (bug #48828).


== Guidelines ==
== Guidelines ==
Line 79: Line 79:
* Add the bug number, e.g. <code>(bug #12345)</code>, where applicable.
* Add the bug number, e.g. <code>(bug #12345)</code>, where applicable.
* Use prefixes where applicable:
* Use prefixes where applicable:
** <code>maint:</code> for reorganisation of the sources that do not change the source. Regular merge commits are a prominent example.
** <code>build:</code> for changes to the build system, for example autoconf or automake files.
** <code>doc:</code> for changes to the documentation.
** <code>doc:</code> for changes to the documentation.
** <code>build:</code> for changes to the build system, for example autoconf or automake files.
** <code>gui:</code> for changes to the graphical user interface.
** <code>maint:</code> for reorganization of the sources that do not change the source. Regular merge commits are a prominent example.
** <code>test:</code> for changes to [[Tests]] only, e.g. new/removed BISTs, changed tolerances, etc.
 


=== Wording ===
=== Wording ===
219

edits