Skip to content

Commit 6d026ae

Browse files
authored
Merge pull request #1 from ark-forge/docs/changelog-contributing
docs: add CHANGELOG and CONTRIBUTING
2 parents 9e9329e + 3d9d113 commit 6d026ae

2 files changed

Lines changed: 127 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented here.
4+
5+
Format: [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
6+
Versioning: [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
7+
8+
---
9+
10+
## [Unreleased]
11+
12+
---
13+
14+
## [0.1.2] — 2026-03-12
15+
16+
### Added
17+
- Hosted MCP scanner CTA displayed after CLI scan output
18+
- MCP server section in README with setup instructions for Claude, Cursor, Windsurf
19+
- Star badge and PATH troubleshooting section in README
20+
21+
### Fixed
22+
- Removed non-existent `suggest` and `check` subcommands from CI workflow
23+
24+
---
25+
26+
## [0.1.1] — 2025-12-01
27+
28+
### Added
29+
- Detection of 26 AI frameworks across GPAI providers, orchestration layers, and ML infrastructure
30+
- EU AI Act risk mapping per framework (high / medium / low)
31+
- GDPR compliance scan (`--gdpr` flag) with personal data detection
32+
- JSON output mode (`--json`) for CI/CD integration
33+
- Python API (`EUAIActScanner`, `GDPRScanner`)
34+
- npx support via npm package
35+
- Actionable remediation guidance per compliance check (what / why / how)
36+
- Risk category auto-suggestion based on detected frameworks
37+
- `--scan-only` flag to skip compliance check and only detect frameworks
38+
- `--risk` flag to override the suggested risk category
39+
40+
### Frameworks detected
41+
- **GPAI providers (High risk)**: OpenAI, Anthropic, Gemini, Mistral, Cohere, DeepSeek, Vertex AI, AWS Bedrock, Azure OpenAI, ZhipuAI, Qwen, Moonshot
42+
- **Orchestration (Medium risk)**: LangChain, LlamaIndex, LiteLLM, CrewAI, AutoGen, Semantic Kernel, Haystack, DSPy, Groq, Replicate, Ollama
43+
- **ML infrastructure (Low risk)**: HuggingFace, TensorFlow, PyTorch
44+
45+
### EU AI Act articles covered
46+
- Art. 5 (Prohibited practices)
47+
- Art. 6 + Annex III (High-risk classification)
48+
- Art. 9 (Risk management)
49+
- Art. 10 (Data governance)
50+
- Art. 11 (Technical documentation)
51+
- Art. 14 (Human oversight)
52+
- Art. 15 (Robustness and cybersecurity)
53+
- Art. 50 / 51-53 (GPAI and transparency obligations)
54+
55+
---
56+
57+
## [0.1.0] — 2025-11-01
58+
59+
### Added
60+
- Initial release
61+
- Zero-dependency project scanner (Python 3.9+)
62+
- Detection of AI framework imports and dependencies across `.py`, `.js`, `.ts`, and other source files
63+
- EU AI Act risk level mapping for common GPAI frameworks
64+
- Basic compliance checklist output
65+
66+
---
67+
68+
[Unreleased]: https://github.com/ark-forge/eu-ai-act-scanner/compare/v0.1.2...HEAD
69+
[0.1.2]: https://github.com/ark-forge/eu-ai-act-scanner/compare/v0.1.1...v0.1.2
70+
[0.1.1]: https://github.com/ark-forge/eu-ai-act-scanner/compare/v0.1.0...v0.1.1
71+
[0.1.0]: https://github.com/ark-forge/eu-ai-act-scanner/releases/tag/v0.1.0

CONTRIBUTING.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributing to eu-ai-act-scanner
2+
3+
## Before you start
4+
5+
Open an issue first for non-trivial changes. For typos and small fixes, a PR directly is fine.
6+
7+
## Branching
8+
9+
- `main` is protected — no direct push
10+
- Branch from `main`: `feat/your-feature` or `fix/your-fix`
11+
- Open a PR against `main`
12+
13+
## Development setup
14+
15+
```bash
16+
git clone https://github.com/ark-forge/eu-ai-act-scanner.git
17+
cd eu-ai-act-scanner
18+
pip install -e ".[dev]"
19+
```
20+
21+
## Running the scanner
22+
23+
```bash
24+
python -m eu_ai_act_scanner scan ./your-project
25+
# or
26+
npx eu-ai-act-scanner scan ./your-project
27+
```
28+
29+
## Running tests
30+
31+
```bash
32+
pytest tests/ -q
33+
```
34+
35+
## Pull request checklist
36+
37+
- [ ] Tests pass locally
38+
- [ ] README updated if behavior changed
39+
- [ ] CHANGELOG entry added under `[Unreleased]`
40+
41+
## What we accept
42+
43+
- Bug fixes
44+
- New AI framework detections (currently 26 supported)
45+
- New EU AI Act / GDPR compliance rules
46+
- CLI improvements
47+
48+
## What requires an issue first
49+
50+
- Changes to the output format
51+
- Breaking CLI interface changes
52+
- New required dependencies
53+
54+
## Questions
55+
56+
Open an issue or reach out at [arkforge.tech](https://arkforge.tech).

0 commit comments

Comments
 (0)