|
| 1 | +<!-- SPDX-License-Identifier: CC-BY-4.0 --> |
| 2 | +<!-- Copyright Contributors to the OpenImageIO Project. --> |
| 3 | + |
| 4 | + |
1 | 5 | Contributing to OpenImageIO |
2 | 6 | =========================== |
3 | 7 |
|
@@ -70,6 +74,26 @@ If confidentiality precludes a public question or issue for any reason, you |
70 | 74 | may contact us privately at [security@openimageio.org](security@openimageio.org). |
71 | 75 |
|
72 | 76 |
|
| 77 | +Policy on AI Tools |
| 78 | +------------------ |
| 79 | + |
| 80 | +Please read our [Policy on AI Coding Assistants](docs/dev/AI_Policy.md) |
| 81 | +before contributing or particpating in the project in any way mediated by "AI" |
| 82 | +assistants. |
| 83 | + |
| 84 | +High-level summary: |
| 85 | +- Human must always be in the loop, and is the responsible party for |
| 86 | + the contents of a PR (including fully understanding and being able |
| 87 | + to explain, defend, and modify it in response to review comments). |
| 88 | +- Interact with the project and community yourself, not by agent. |
| 89 | +- Disclose what tools you used and how. At a minimum, we require an |
| 90 | + "Assisted-by: TOOL/MODEL" line in the commit comments and PR description. |
| 91 | +- Don't waste maintainer's time with low quality PRs. |
| 92 | + |
| 93 | +Please do read the whole [Policy on AI Coding Assistants](docs/dev/AI_Policy.md) |
| 94 | +for all the details. |
| 95 | + |
| 96 | + |
73 | 97 | Contributor License Agreement (CLA) and Intellectual Property |
74 | 98 | ------------------------------------------------------------- |
75 | 99 |
|
@@ -230,33 +254,33 @@ repository. The protocol is like this: |
230 | 254 | your own repository on GitHub, and then clone it to get a repository on your |
231 | 255 | local machine. |
232 | 256 |
|
233 | | -1. Edit, compile, and test your changes. Run clang-format (see the |
| 257 | +2. Edit, compile, and test your changes. Run clang-format (see the |
234 | 258 | instructions on coding style below). |
235 | 259 |
|
236 | | -1. Push your changes to your fork (each unrelated pull request to a separate |
| 260 | +3. Push your changes to your fork (each unrelated pull request to a separate |
237 | 261 | "topic branch", please). |
238 | 262 |
|
239 | | -1. Make a "pull request" on GitHub for your patch. |
| 263 | +4. Make a "pull request" on GitHub for your patch. |
240 | 264 |
|
241 | | -2. If your patch will induce a major compatibility break, or has a design |
| 265 | +5. If your patch will induce a major compatibility break, or has a design |
242 | 266 | component that deserves extended discussion or debate among the wider OIIO |
243 | 267 | community, then it may be prudent to email oiio-dev pointing everybody to |
244 | 268 | the pull request URL and discussing any issues you think are important. |
245 | 269 |
|
246 | | -1. All pull requests automatically launch CI jobs on GitHub Actions to |
| 270 | +6. All pull requests automatically launch CI jobs on GitHub Actions to |
247 | 271 | ensure that the build completes and that the tests suite runs correctly, for |
248 | 272 | a variety of platform, compiler, library, and flag combinations. The status |
249 | 273 | of the CI tests for your PR will be displayed on the GitHub PR page. We will |
250 | 274 | not accept PRs that don't build cleanly or pass the existing testsuite. |
251 | 275 |
|
252 | | -1. The reviewer will look over the code and critique on the "comments" area. |
| 276 | +7. The reviewer will look over the code and critique on the "comments" area. |
253 | 277 | Reviewers may ask for changes, explain problems they found, congratulate the |
254 | 278 | author on a clever solution, etc. But until somebody says "LGTM" (looks good |
255 | 279 | to me), the code should not be committed. Sometimes this takes a few rounds |
256 | 280 | of give and take. Please don't take it hard if your first try is not |
257 | 281 | accepted. It happens to all of us. |
258 | 282 |
|
259 | | -1. After approval, one of the senior developers (with commit approval to the |
| 283 | +8. After approval, one of the senior developers (with commit approval to the |
260 | 284 | official main repository) will merge your fixes into the main branch. |
261 | 285 |
|
262 | 286 | Please see the [Code Review](docs/dev/CodeReview.md) document for more |
|
0 commit comments