Skip to content

Commit 5f380dc

Browse files
committed
chore: Add community health files (CONTRIBUTING, SECURITY, CITATION)
1 parent 64200a1 commit 5f380dc

File tree

3 files changed

+78
-0
lines changed

3 files changed

+78
-0
lines changed

CITATION.cff

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
cff-version: 1.2.0
2+
message: "If you use this software in your research or agency, please cite it as below."
3+
authors:
4+
- family-names: "Tunnel"
5+
given-names: "Tam"
6+
title: "AI Governance Hub"
7+
version: 0.4.0
8+
date-released: 2024-01-01
9+
url: "https://github.com/TamTunnel/AI-Governance-Hub"
10+
repository-code: "https://github.com/TamTunnel/AI-Governance-Hub"
11+
license: "Apache-2.0"
12+
abstract: "A centralized, open-source platform for managing AI models, aligned with NIST AI RMF and EU AI Act requirements. Features include Model Registry, Risk Profiles, Policy Enforcement, and Lineage Tracking."
13+
keywords:
14+
- ai-governance
15+
- nist-ai-rmf
16+
- eu-ai-act
17+
- model-registry
18+
- compliance
19+
- responsible-ai

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing to AI Governance Hub
2+
3+
Thank you for your interest in contributing to AI Governance Hub! This project is open-source and we welcome contributions from the community.
4+
5+
## 🤝 Core Principles
6+
* **Safety First:** All code must respect the sensitive nature of governance data. No heavy external dependencies without review.
7+
* **Compliance Alignment:** Features should map to specific frameworks (NIST, EU AI Act) where possible.
8+
* **Documentation:** Every PR must update the relevant docs. This tool lives and dies by its ability to explain *why* it matters.
9+
10+
## 🛠️ Development Setup
11+
1. Clone the repo: `git clone https://github.com/TamTunnel/AI-Governance-Hub.git`
12+
2. Install dependencies: `cd backend && poetry install`
13+
3. Run the stack: `docker compose up --build`
14+
4. Run tests: `cd backend && pytest`
15+
16+
## 📝 Pull Request Process
17+
1. Create a feature branch: `git checkout -b feature/amazing-feature`
18+
2. Commit your changes: `git commit -m 'feat: Add amazing feature'`
19+
3. Push to the branch: `git push origin feature/amazing-feature`
20+
4. Open a Pull Request.
21+
22+
## 🧪 Testing
23+
* Backend: `pytest` (ensure 100% pass rate)
24+
* Frontend: `npm run test`
25+
* Linting: `ruff check .`
26+
27+
## 📜 License
28+
By contributing, you agree that your contributions will be licensed under the [Apache License 2.0](../LICENSE).

SECURITY.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Security Policy
2+
3+
## 🛡️ Reporting a Vulnerability
4+
5+
**Do not open a GitHub Issue for security vulnerabilities.**
6+
7+
If you discover a security vulnerability in AI Governance Hub, please verify it is reproducible and send a report to:
8+
9+
**security@example.com** (Replace with actual security email if available, otherwise suggest private vulnerability reporting via GitHub)
10+
11+
* We will acknowledge your report within 48 hours.
12+
* We will provide a timeline for a fix.
13+
* Please do not disclose the vulnerability publicly until a fix is released.
14+
15+
## 🔒 Supported Versions
16+
17+
| Version | Supported |
18+
| :--- | :--- |
19+
| 0.4.x | ✅ Yes |
20+
| 0.3.x | ❌ No |
21+
| < 0.3 | ❌ No |
22+
23+
## 🔐 Deployment Security
24+
25+
For production deployments in government or enterprise:
26+
1. **Always** deploy behind a TLS-terminating reverse proxy (Nginx).
27+
2. **Enable** the RBAC policies suitable for your organization.
28+
3. **Rotate** `SECRET_KEY` and Database Credentials regularly.
29+
4. **Isolate** the database network from the public internet.
30+
31+
See [Deployment & Security](https://github.com/TamTunnel/AI-Governance-Hub/wiki/Deployment_and_Security) in the Wiki for air-gapped architecture.

0 commit comments

Comments
 (0)