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