Skip to content

Commit 0d818e7

Browse files
author
CortexPrism
committed
style: format all file types (md, json, yml, ts)
1 parent e8d7a74 commit 0d818e7

4 files changed

Lines changed: 391 additions & 367 deletions

File tree

‎AI.md‎

Lines changed: 53 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,53 @@
1-
# AI Disclosure
2-
3-
This file documents any AI-assisted development used in this plugin.
4-
5-
## Tools Used
6-
7-
- GitHub Copilot (code generation)
8-
- Claude (code review and documentation)
9-
10-
## Scope
11-
12-
AI assistance was used in the following areas:
13-
14-
- `mod.ts` — Core logic was drafted by GitHub Copilot, manually reviewed and modified
15-
- `README.md` — Initial structure by Claude, edited for accuracy
16-
- `test/unit/mod.test.ts` — Test cases generated by GitHub Copilot, verified for correctness
17-
- `manifest.json` — Manual configuration, no AI assistance
18-
19-
## Review
20-
21-
All AI-generated code was reviewed by a human developer, tested thoroughly, and verified to work correctly before being committed to this repository.
22-
23-
## Certification
24-
25-
I certify that I understand the code being submitted and take full responsibility for its behavior and security.
26-
27-
---
28-
29-
## Disclosure in manifest.json
30-
31-
The `manifest.json` file includes this disclosure:
32-
33-
```json
34-
{
35-
"aiDisclosure": {
36-
"tools": ["copilot", "claude"],
37-
"generatedFiles": ["mod.ts", "README.md", "test/unit/mod.test.ts"],
38-
"humanReviewed": true,
39-
"statement": "All AI-generated code was reviewed, tested, and verified for correctness and security."
40-
}
41-
}
42-
```
43-
44-
---
45-
46-
## Why This Matters
47-
48-
- **Trust** — Users know what to expect from the code
49-
- **Review** — Marketplace reviewers can assess AI-generated vs. human-written code
50-
- **Security** — Extra scrutiny is paid to AI-generated code for vulnerabilities
51-
- **Attribution** — Proper credit for the development process
1+
# AI Disclosure
2+
3+
This file documents any AI-assisted development used in this plugin.
4+
5+
## Tools Used
6+
7+
- GitHub Copilot (code generation)
8+
- Claude (code review and documentation)
9+
10+
## Scope
11+
12+
AI assistance was used in the following areas:
13+
14+
- `mod.ts` — Core logic was drafted by GitHub Copilot, manually reviewed and modified
15+
- `README.md` — Initial structure by Claude, edited for accuracy
16+
- `test/unit/mod.test.ts` — Test cases generated by GitHub Copilot, verified for correctness
17+
- `manifest.json` — Manual configuration, no AI assistance
18+
19+
## Review
20+
21+
All AI-generated code was reviewed by a human developer, tested thoroughly, and verified to work
22+
correctly before being committed to this repository.
23+
24+
## Certification
25+
26+
I certify that I understand the code being submitted and take full responsibility for its behavior
27+
and security.
28+
29+
---
30+
31+
## Disclosure in manifest.json
32+
33+
The `manifest.json` file includes this disclosure:
34+
35+
```json
36+
{
37+
"aiDisclosure": {
38+
"tools": ["copilot", "claude"],
39+
"generatedFiles": ["mod.ts", "README.md", "test/unit/mod.test.ts"],
40+
"humanReviewed": true,
41+
"statement": "All AI-generated code was reviewed, tested, and verified for correctness and security."
42+
}
43+
}
44+
```
45+
46+
---
47+
48+
## Why This Matters
49+
50+
- **Trust** — Users know what to expect from the code
51+
- **Review** — Marketplace reviewers can assess AI-generated vs. human-written code
52+
- **Security** — Extra scrutiny is paid to AI-generated code for vulnerabilities
53+
- **Attribution** — Proper credit for the development process

‎CHANGELOG.md‎

Lines changed: 79 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,79 @@
1-
# Changelog
2-
3-
All notable changes to this project will be documented in this file.
4-
5-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7-
8-
## [Unreleased]
9-
10-
### Added
11-
- Initial project setup
12-
13-
## [1.0.0] — 2026-06-15
14-
15-
### Added
16-
- Initial release of example-plugin
17-
- `hello` capability — Greet a person
18-
- `add` capability — Add two numbers
19-
- `fetchData` capability — Fetch data from external APIs
20-
21-
### Changed
22-
- N/A
23-
24-
### Fixed
25-
- N/A
26-
27-
### Deprecated
28-
- N/A
29-
30-
### Removed
31-
- N/A
32-
33-
### Security
34-
- N/A
35-
36-
---
37-
38-
## How to Write Changelog Entries
39-
40-
When you make changes, add entries under `[Unreleased]` following these guidelines:
41-
42-
- **Added** for new features
43-
- **Changed** for changes in existing functionality
44-
- **Deprecated** for soon-to-be removed features
45-
- **Removed** for now removed features
46-
- **Fixed** for any bug fixes
47-
- **Security** for vulnerability fixes
48-
49-
When you release a new version:
50-
51-
1. Rename `[Unreleased]` to `[VERSION] — DATE` (e.g., `[1.1.0] — 2026-06-20`)
52-
2. Add a new `[Unreleased]` section at the top
53-
3. Update version in `manifest.json`
54-
4. Commit and tag: `git tag v1.1.0`
55-
56-
Example:
57-
```markdown
58-
## [1.1.0] — 2026-06-20
59-
60-
### Added
61-
- New `multiply` capability
62-
63-
### Fixed
64-
- Timeout handling in `fetchData`
65-
66-
### Security
67-
- Added input validation to prevent injection attacks
68-
```
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project
6+
adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Added
11+
12+
- Initial project setup
13+
14+
## [1.0.0] — 2026-06-15
15+
16+
### Added
17+
18+
- Initial release of example-plugin
19+
- `hello` capability — Greet a person
20+
- `add` capability — Add two numbers
21+
- `fetchData` capability — Fetch data from external APIs
22+
23+
### Changed
24+
25+
- N/A
26+
27+
### Fixed
28+
29+
- N/A
30+
31+
### Deprecated
32+
33+
- N/A
34+
35+
### Removed
36+
37+
- N/A
38+
39+
### Security
40+
41+
- N/A
42+
43+
---
44+
45+
## How to Write Changelog Entries
46+
47+
When you make changes, add entries under `[Unreleased]` following these guidelines:
48+
49+
- **Added** for new features
50+
- **Changed** for changes in existing functionality
51+
- **Deprecated** for soon-to-be removed features
52+
- **Removed** for now removed features
53+
- **Fixed** for any bug fixes
54+
- **Security** for vulnerability fixes
55+
56+
When you release a new version:
57+
58+
1. Rename `[Unreleased]` to `[VERSION] — DATE` (e.g., `[1.1.0] — 2026-06-20`)
59+
2. Add a new `[Unreleased]` section at the top
60+
3. Update version in `manifest.json`
61+
4. Commit and tag: `git tag v1.1.0`
62+
63+
Example:
64+
65+
```markdown
66+
## [1.1.0] — 2026-06-20
67+
68+
### Added
69+
70+
- New `multiply` capability
71+
72+
### Fixed
73+
74+
- Timeout handling in `fetchData`
75+
76+
### Security
77+
78+
- Added input validation to prevent injection attacks
79+
```

0 commit comments

Comments
 (0)