Committing code#
Follow these commit rules:
Work in feature branches where possible (see Branching policy)
Commit early, commit often.
Have the Jira story ID at the beginning of your commit messages. (You can also use GitLab and Jira integration)
Git logs must be human-readable, describing the development activity in sequence.
Use imperative forms in the commit message:
ST-320 make fluentd,kibana,elasticsearch optional
* add a pipeline example for disabling ELK
* add enabled checks
* filebeat,journalbeat support added to clusters
# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
#
# Date: Tue May 12 11:24:17 2020 +1200
#
# On branch st-320-swap-out-fluentd
# Your branch is up-to-date with 'origin/st-320-swap-out-fluentd'.
For more guidance, see How to write a good commit message https://chris.beams.io/posts/git-commit/.`
Squashing commits#
To replace a series of small commits with a single commit, or to reorder them, use an interactive rebase (git rebase -i`). When squashing commits, keep the following in mind:`
Never rebase commits you have pushed to a remote server.
Never rebase commits authored by other people.
Avoid squashing commits in SKA repositories.