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
|
Audit evidence (disclosure) files (per PR) need to be put here by
human contributor (PR submitter), named `<branch-name>.md`.
The disclosure file must **follow the exact format and content**
as described below.
**Example 1** file contents of a 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 a 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. The
disclosure file cannot have both or none of the first two marks
checked, and you must always have the last tick checked.
|