gnuastro-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[gnuastro-devel] Updates in coding and commit conventions


From: Mohammad Akhlaghi
Subject: [gnuastro-devel] Updates in coding and commit conventions
Date: Thu, 5 May 2016 13:51:33 +0900
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:45.0) Gecko/20100101 Thunderbird/45.0

Hi,

Two commits were just pushed to master which can be summarized as below:

1. The line-widths of all hand-written text in Gnuastro (source code, documentation, and commit messages) was set to 75 (instead of 70 before) and the .dir-locals.el file was updated. The reasoning is explained in the commit message and also throughout the book text.

2. A convention is suggested for the commit message titles: that they start with a short category before the actual title. This is done to more easily go through the commit logs. Note that not all changes can be classified by files (so Git can automatically separate the commits we want), for example a change in the book can easily be about any of the utilities, libraries, development, installation and so on.

As explained in the manual, especially at this stage, none of these conventions are carved in stone (unchangable), so please share your thoughts on them in this list. We will tentatively follow these conventions and if there is no comments, they can be more strongly accepted, other wise, we will update them. But until then please follow them and share your experience if you feel they should be changed.

Cheers,

Mohammad




reply via email to

[Prev in Thread] Current Thread [Next in Thread]