Skip to content

Commit dc2d114

Browse files
committed
Add note about AI coding tools.
1 parent 0af3dd2 commit dc2d114

1 file changed

Lines changed: 62 additions & 1 deletion

File tree

DEVELOPING.md

Lines changed: 62 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,41 @@ Please see the [Contributing to CUPS](CONTRIBUTING.md) file for information on
55
contributing to the CUPS project.
66

77

8+
Contents
9+
--------
10+
11+
- [How To Contact The Developers](#how-to-contact-the-developers)
12+
- [Interfaces](#interfaces)
13+
- [Build System](#build-system)
14+
- [Version Numbering](#version-numbering)
15+
- [Coding Guidelines](#coding-guidelines)
16+
- [Using Coding AI Tools](#using-ai-coding-tools)
17+
- [Source Files](#source-files)
18+
- [Header Files](#header-files)
19+
- [Comments](#comments)
20+
- [Indentation](#indentation)
21+
- [Spacing](#spacing)
22+
- [Return Values](#return-values)
23+
- [Functions](#functions)
24+
- [Variables](#variables)
25+
- [Types](#types)
26+
- [Structures](#structures)
27+
- [Constants](#constants)
28+
- [Shell Script Guidelines](#shell-script-guidelines)
29+
- [Makefile Guidelines](#makefile-guidelines)
30+
- [General Organization](#general-organization)
31+
- [Makefile Documentation](#makefile-documentation)
32+
- [Portable Makefile Construction](#portable-makefile-construction)
33+
- [Standard Variables](#standard-variables)
34+
- [Standard Targets](#standard-targets)
35+
- [Object Files](#object-files)
36+
- [Programs](#programs)
37+
- [Static Libraries](#static-libraries)
38+
- [Shared Libraries](#shared-libraries)
39+
- [Dependencies](#dependencies)
40+
- [Install/Uninstall Support](#installuninstall-support)
41+
42+
843
How To Contact The Developers
944
-----------------------------
1045

@@ -119,6 +154,21 @@ Manual, which is generated using the [codedoc](https://www.msweet.org/codedoc)
119154
software.
120155

121156

157+
### Using AI Coding Tools
158+
159+
The use of AI coding tools must be disclosed when you submit an issue or pull
160+
request. In the interest of standardization, please include the Linux Kernel
161+
["Assisted-by"](https://docs.kernel.org/process/coding-assistants.html) tag in
162+
the description:
163+
164+
Assisted-by: AGENT_NAME:MODEL_VERSION [TOOL1] [TOOL2]
165+
166+
> *Note:* Purely AI-generated code cannot be accepted for legal and ethical
167+
> reasons. AI code contributions must be manually reviewed and submitted by
168+
> a person with the legal capacity to provide such code under the terms of the
169+
> libcups license.
170+
171+
122172
### Source Files
123173

124174
All source files names must consist of lowercase ASCII letters, numbers, dash
@@ -399,7 +449,18 @@ typedef enum cups_tray_e // Tray enumerations
399449
```
400450

401451

402-
## Makefile Guidelines
452+
Shell Script Guidelines
453+
-----------------------
454+
455+
All shell scripts in libcups must conform to the [POSIX shell][POSIX-SHELL]
456+
command language and should restrict their dependence on non-POSIX utility
457+
commands.
458+
459+
[POSIX-SHELL]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18
460+
461+
462+
Makefile Guidelines
463+
-------------------
403464

404465
The following is a guide to the POSIX makefile-based build system used by CUPS.
405466
These guidelines have been developed over the years to allow CUPS to be built on

0 commit comments

Comments
 (0)