@@ -45,19 +45,6 @@ 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-
6148### Documentation
6249
6350A new role must get proper documentation. Please edit the README.md located in
@@ -99,6 +86,71 @@ role, and re-run `make role_molecule` to re-generate the the jobs and project li
9986
10087Please add a note in the role README.md for future reference.
10188
89+ ## A few words about using Git
90+
91+ Before you make a pull request, make sure that:
92+
93+ * the title of your git commit message begins with the role
94+ name in brackets: ` [my_wonderful_role] ` or ` (my_wonderful_role) `
95+ * the git commit body message is longer than 10 characters and describes
96+ the reason why you added this change
97+ * sign your git commit using the ` Signed-Off-By ` option by
98+ adding: ` --signoff ` or ` -s ` when using the command: ` git commit ` .
99+ * if you already make a commit, and you want to add ` Signed-Off-By ` ,
100+ use command: ` git commit --amend --signoff `
101+
102+ ## AI/LLM Assisted Development
103+
104+ When using AI tools for contributions, follow these guidelines to ensure transparency and code quality.
105+
106+ ### Attribution Requirements
107+
108+ * ** Major AI contribution** (substantial code/logic generation): Use ` Co-Authored-By: `
109+ * ** Minor AI assistance** (refactoring/optimization): Use ` Assisted-By: `
110+
111+ ~~~
112+ [role_name] Add EDPM validation logic
113+
114+ Implements connectivity tests and health monitoring for EDPM nodes.
115+
116+ Co-Authored-By: Claude Code <noreply@anthropic.com>
117+ Signed-off-by: Your Name <your.email@example.com>
118+ ~~~
119+
120+ ~~~
121+ [role_name] Refactor validation error handling
122+
123+ Simplified logic and improved debugging messages.
124+
125+ Assisted-By: Gemini <noreply@google.com>
126+ Signed-off-by: Your Name <your.email@example.com>
127+ ~~~
128+
129+ ### Code Quality Requirements
130+
131+ Before submitting AI-assisted code:
132+
133+ * Review all generated code for correctness and security
134+ * Ensure compliance with existing project patterns and naming conventions
135+ * Verify no hardcoded credentials or sensitive data exposure
136+ * Test thoroughly, especially edge cases and error scenarios
137+ * Add proper documentation and comments
138+
139+ ### Review Process
140+
141+ * Complete thorough self-review before PR submission
142+ * Standard review policy applies (minimum 2 reviewers)
143+ * Security-sensitive code requires additional maintainer review
144+ * Disclose AI assistance scope in PR description
145+
146+ ### Security and Best Practices
147+
148+ * Never share sensitive project data with AI tools
149+ * Don't use AI for credential generation or security policy decisions
150+ * Provide relevant project context when prompting AI tools
151+ * Use AI as a starting point, not final solution
152+ * Maintain human oversight throughout development process
153+
102154## Adding new script
103155
104156If you want/need to add a new script (python, bash, perl, ...), please provide
0 commit comments