... | ... | @@ -63,6 +63,22 @@ The beginning of each file (after the help text, but not contiguous) should cont |
|
|
% write to the Free Software Foundation, Inc., 59 Temple Place,
|
|
|
% Suite 330, Boston, MA 02111-1307 USA
|
|
|
```
|
|
|
# Changelog
|
|
|
Change logs for the project exist in CHANGELOG and should be formatted as below.
|
|
|
Please note double spaces and ensure you leave a space between change entries. See
|
|
|
[GNU Style](https://www.gnu.org/prep/standards/html_node/Change-Logs.html#Change-Logs) for more details.
|
|
|
```
|
|
|
YYYY-MM-DD John Doe <johndoe@example.com>
|
|
|
|
|
|
* myfile.ext (myfunction): my changes made
|
|
|
additional changes
|
|
|
|
|
|
* myfile.ext (unrelated_change): my changes made
|
|
|
to myfile.ext but completely unrelated to the above
|
|
|
|
|
|
* anotherfile.ext (somefunction): more changes
|
|
|
```
|
|
|
|
|
|
# Logging
|
|
|
Instead of using `disp()` or `printf()` use [matlog](https://github.com/co60ca/matlog) instead. This will allow us to pick what level of logging we want in each script and wont pollute the standard output. Additionally, logging_log includes much more useful information such as the time since last log message, time since program start, clock time and call site (file and line number). It may also print call stacks in the case of 'ERROR' and 'WARN'
|
|
|
|
... | ... | |