|
1 | 1 | ## Description |
2 | 2 |
|
3 | | -Please explain the changes you are proposing: |
| 3 | +Please explain the changes you are proposing. |
4 | 4 |
|
5 | 5 | --- |
6 | 6 |
|
7 | 7 | ## Related Issue(s) |
8 | 8 |
|
9 | | -Closes # |
| 9 | +Closes or relates to # |
10 | 10 |
|
11 | 11 | --- |
12 | 12 |
|
13 | 13 | ## Checklist |
14 | 14 |
|
15 | 15 | - [ ] I have referenced relevant issue numbers above |
16 | 16 | - [ ] I have performed a self-review of my code |
17 | | -- [ ] I have added tests that prove my fix is effective or that my feature works |
| 17 | +- [ ] I have added tests that prove my fix is effective or that |
| 18 | + my feature works |
18 | 19 | - [ ] I have added necessary documentation (if appropriate) |
19 | 20 | - [ ] My code follows the style guidelines of this project |
20 | 21 |
|
21 | 22 | --- |
22 | 23 |
|
23 | 24 | ## AI Assistance Disclosure |
24 | 25 |
|
25 | | -Please check one: |
| 26 | +:warning: **Required for this PR:** You MUST include a disclosure |
| 27 | +file at `.audit/<branch-name>.md` right in this PR. Submitting |
| 28 | +code generated _primarily_ by AI, or for which you cannot claim |
| 29 | +_human authorship_, is not permitted. See |
| 30 | +[AI Policy](https://github.com/crossbario/txaio/blob/main/AI_POLICY.md) |
| 31 | +for details. The disclosure file must **follow the exact format |
| 32 | +and content** as described below. _Your PR will not be accepted |
| 33 | +without a disclosure file._ |
26 | 34 |
|
27 | | -- [ ] I did NOT use AI tools to generate code/content for this PR. |
28 | | -- [ ] I used AI tools to assist with this PR. (If checked, please describe how AI was used, and ensure you reviewed, modified, and take full responsibility for all contributions, per our [AI Policy](../AI_POLICY.rst).) |
| 35 | +**Example 1** file contents of your disclosure file |
| 36 | +`.audit/<branch-name>.md`: |
29 | 37 |
|
30 | | -**NOTE:** Submitting code generated primarily by AI, or for which you cannot claim human authorship, is not permitted. See [AI_POLICY.rst](../AI_POLICY.rst). |
| 38 | +``` |
| 39 | +## AI Assistance Disclosure |
| 40 | +
|
| 41 | +- [ ] I did **not** use any AI-assistance tools to help create this pull request. |
| 42 | +- [x] I **did** use AI-assistance tools to *help* create this pull request. |
| 43 | +- [x] I have read, understood and followed the projects' [AI Policy](https://github.com/crossbario/txaio/blob/main/AI_POLICY.md) when creating code, documentation etc. for this pull request. |
| 44 | +
|
| 45 | +Submitted by: @your-github-username |
| 46 | +Date: YYYY-MM-DD |
| 47 | +Related issue(s): #issue-number |
| 48 | +Branch: branch-name |
| 49 | +``` |
| 50 | + |
| 51 | +**OR** |
| 52 | + |
| 53 | +**Example 2** file contents of your disclosure file |
| 54 | +`.audit/<branch-name>.md`: |
| 55 | + |
| 56 | +``` |
| 57 | +## AI Assistance Disclosure |
| 58 | +
|
| 59 | +- [x] I did **not** use any AI-assistance tools to help create this pull request. |
| 60 | +- [ ] I **did** use AI-assistance tools to *help* create this pull request. |
| 61 | +- [x] I have read, understood and followed the projects' [AI Policy](https://github.com/crossbario/txaio/blob/main/AI_POLICY.md) when creating code, documentation etc. for this pull request. |
| 62 | +
|
| 63 | +Submitted by: @your-github-username |
| 64 | +Date: YYYY-MM-DD |
| 65 | +Related issue(s): #issue-number |
| 66 | +Branch: branch-name |
| 67 | +``` |
| 68 | + |
| 69 | +**Example 1 OR Example 2** show the only valid two variants. You |
| 70 | +cannot have both or none of the first two marks checked, and you |
| 71 | +must always have the last tick checked. |
| 72 | + |
| 73 | +Well, "must" if you want your PR to be accepted and ultimately |
| 74 | +merged that is. Of course you are always free to |
| 75 | +`Go ahead! Fork my Day. (TM)` ;) This is Open-source. |
0 commit comments