Skip to content

Commit d9ce2aa

Browse files
danpawliksdatko
andcommitted
Add Github action that verify commit message prefix
If the PR is related to some role, it would verify if in the title or commit message header there is prefix set. For example, if change was done for roles/cifmw_helpers, it should verify if the title or commit message header contains [cifmw_helpers]. Co-Authored-By: Szymon Datko <[email protected]> Signed-off-by: Daniel Pawlik <[email protected]>
1 parent 7a0efb5 commit d9ce2aa

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,19 @@ Here is an example, based on a common use-case, on how to use those variables
4545
oc get openstackdataplane -n {{ cifmw_install_yamls_defaults['NAMESPACE'] }}
4646
~~~
4747

48+
## A few words about using Git
49+
50+
Before you make a pull request, make sure that:
51+
52+
* the title of your git commit message begins with the role
53+
name in brackets: `[my_wonderful_role]` or `(my_wonderful_role)`
54+
* the git commit body message is longer than 10 characters and describes
55+
the reason why you added this change
56+
* sign your git commit using the `Signed-Off-By` option by
57+
adding: `--signoff` or `-s` when using the command: `git commit`.
58+
* if you already make a commit, and you want to add `Signed-Off-By`,
59+
use command: `git commit --amend --signoff`
60+
4861
### Documentation
4962

5063
A new role must get proper documentation. Please edit the README.md located in

0 commit comments

Comments
 (0)