[Bioc-devel] Best practice on commit

[Tyler Smith]

On Sun, Mar 11, 2018, at 4:10 AM, Egon Willighagen wrote:
> But previously I learned that when you push
> something to the repository, you should bump the question, so currently I
> do this for every change I made, leaving a ridiculous number of minor
> release and really short NEWS entries...

I wondered about this, particularly for the NEWS entries. What I have been doing is bumping the version number for each commit - to make sure that the checks on the server get run - but collapsing multiple version bullets into a single NEWS item. i.e., my NEWS looks like:

++++
Changes in version 1.5.6 (2018-03-08)
-------------------------------------

User Visible Changes:

    * BUG FIX: the G2 peak of the B sample was not getting incorporated
      into model construction, which caused model fitting to fail on
      samples with histograms skewed towards the left.

    * Updated DebrisModel documentation.

Internal Changes:

    * Fixed broken test.

Changes in version 1.5.3 (2018-01-17)
-------------------------------------

++++

I think that will be more convenient for users, who won't care that the bug fix, updated documentation, and fixed test were actually three different commits. If they do want that level of detail, that information is available directly from the repository. And from my perspective, I definitely wanted to bump the version for at least the test fix and the bug fix, to make sure that the server-side tests were run.

Best,

Tyler