Commit message guidelines: Difference between revisions

Jump to navigation Jump to search
(create examples section)
Line 50: Line 50:


For m-script and Fortran sources, the function name can be omitted if the m-script only contains one file. For changes outside of functions or classes, of course the parenthetical (function) or (class::function) specifiers can also be omitted.
For m-script and Fortran sources, the function name can be omitted if the m-script only contains one file. For changes outside of functions or classes, of course the parenthetical (function) or (class::function) specifiers can also be omitted.
== Examples ==
* standard commit messages
<pre>
add format option to ticklabel (bug #34906)
* graphics.cc: add new functions to support different input arguments to
  xyzticklabel. Add tests.
* graphics.in.h: define set_xyzticklabel as external function
</pre>
<pre>
tag symbols in indexed assignments as variables (bug #39240)
* pt-arg-list.cc (tree_argument_list::variable_names): Also return the
  symbol names from index expressions.
* parser.tst: New test.
</pre>
* For short and very simple commit messages under 80 characters.
<pre>@ftp/cd.m: Fix docstring.</pre>
<pre>strjoin.m: delimiter can include escape sequences (matlab compatibility)</pre>
* maintenance or docs commits, no actual code changed
<pre>maint: update config.in.h in .hgignore</pre>


[[Category:Development]]
[[Category:Development]]