Skip to content

Commit 2acd2d3

Browse files
authored
Add a Code Assistant section to the Contribute guide (teemtee#3969)
Let's explicitly document the format to be used for specifying code assistant contributions in the commit messages.
1 parent 7ac5e59 commit 2acd2d3

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/contribute.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,30 @@ You can get some more context in the `stackoverflow`__ article.
9090

9191
__ https://stackoverflow.com/questions/2290016/
9292

93+
94+
Code Assistants
95+
------------------------------------------------------------------
96+
97+
When a code assistant tool is used during the code creation use
98+
the following format for storing the attribution in the commit
99+
message:
100+
101+
Assisted-by
102+
when the tool has partially improved, polished or enhanced the
103+
code written by you
104+
105+
Generated-by
106+
in cases when the majority of the code was generated by the
107+
tool itself
108+
109+
For example:
110+
111+
.. code-block::
112+
113+
Assisted-by: Claude
114+
Generated-by: Cursor
115+
116+
93117
.. _develop:
94118

95119
Develop

0 commit comments

Comments
 (0)