DOC explain commit message prefixes and other jargon in developers' guide #1882
Comments
|
We don't actually use these prefixes consistently (and even some core developers don't use them). We use them when doing bugfix releases, as they make it easy to grep through the log and find the commits to cherry-pick. If we want to document this, we first need to decide on conventions, which is the matter for the ML rather than the issue tracker. |
|
Yes, I've noticed some core devs don't use them; I thought they should be glossed even if they're not enforced / consistent. That doesn't require a policy decision, just enough of a working definition for common prefixes. |
|
I could write something up in the following weeks, but not right now. Suffice it to say that atomic commits are actually discouraged: whenever an enhancement is committed, the tests should be included. Ideally, each commit represents the project in a working state with full test coverage. (If you manage to decipher the conventions and write something up, be my guest!) |
|
what is cosmit |
Cosmetic commit :) |
|
I'm going to cover WIP/MRG elsewhere. |
scikit-learn's commit log tends to use prefixes on commit messages that don't seem to be documented anywhere. (The developers' guide doesn't say anything about commit messages; it does say every issue and PR should have tags, but non-priveleged users are not permitted to add them.)
The listing over at numpy is useful (http://docs.scipy.org/doc/numpy/dev/gitwash/development_workflow.html), but doesn't correspond to what is used here (e.g. BUG vs FIX, MAINT/STY vs COSMIT).
At the same time, these should be explained: is their purpose to encourage atomic commits (i.e. don't do ENH and TST in the same commit)? or for analytics (well, the current informality won't make that much use)? or is it an irrelevant hangover from related projects (even so, n00bs should have some explanation so they don't spend too long confused)?
The meaning of
WIPandMRGprefixes on PR titles similarly seems to be unexplained. (It might also be useful if the developers' guide introduced the acronym PR.)The text was updated successfully, but these errors were encountered: