We have a rule of using 50 caracters for the summary. However, if we start the summary with "Feature #XYZ", a lot of caracters are then already taken. We should settle for a standard, something like:
FXYZ: This is a new feature implemented.
BXYZ: This is a bug fix.
For the moment, I use the current standard, which is using the "Feature" word fully, but I am breaking the 50 caracters rule by doing so.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
== Tracking Changes
If one does not already exist, create a tracker entry, bug or feature, for the change.
== Keep Current with Master
Contribute changes using Merge Requests (preferred) or patches attached to tracker entries.
== Update changes.xml
Add an entry for the change to changes.xml. Include a terse summary at the end of description. See existing entries for examples. Include this file in the commit with the code changes.
== Commit Messages
Follow git standard good commit message practices. Good references on this include:
We have a rule of using 50 caracters for the summary. However, if we start the summary with "Feature #XYZ", a lot of caracters are then already taken. We should settle for a standard, something like:
FXYZ: This is a new feature implemented.
BXYZ: This is a bug fix.
For the moment, I use the current standard, which is using the "Feature" word fully, but I am breaking the 50 caracters rule by doing so.
Nice idea, I like Fnnn and Bnnn.
It's a git "standard" for the topic/summary and is so to work best with all tools, so we should always comply with that.
Some quick notes to help this:
== Tracking Changes
If one does not already exist, create a tracker entry, bug or feature, for the change.
== Keep Current with Master
Contribute changes using Merge Requests (preferred) or patches attached to tracker entries.
== Update changes.xml
Add an entry for the change to changes.xml. Include a terse summary at the end of description. See existing entries for examples. Include this file in the commit with the code changes.
== Commit Messages
Follow git standard good commit message practices. Good references on this include:
https://chris.beams.io/posts/git-commit/#seven-rules
https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
https://wiki.openstack.org/wiki/GitCommitMessages
Additionally, prefix the commit topic with F (for feature) or B (for bug) and the tracker id, e.g. Fnnn or Bnnn. See the commit history for examples.
== Discussions and Questions
For questions, assistance, or other help, please comment on the tracker item, merge request, or email the dev list.
Last edit: Jeff Jensen 2019-03-22