Skip to content

Commit 9fbd820

Browse files
committed
docs: add CONTRIBUTING.md, SECURITY.md, CHANGELOG.md
1 parent 306499e commit 9fbd820

3 files changed

Lines changed: 109 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Changelog
2+
3+
All notable changes to AIEP Hub will be documented in this file.
4+
5+
Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
6+
7+
## [Unreleased]
8+
9+
## [1.0.0] - 2026-03-28
10+
11+
### Added
12+
- Initial Astro 4 site with 343 specification pages
13+
- Primer CSS integration — exact GitHub visual baseline
14+
- Cloudflare Pages deployment with `wrangler.toml`
15+
- Cloudflare Worker for `.well-known/` discovery endpoints
16+
- `GENOME_LOCKFILE.json` and `SHA256SUMS.txt` integrity manifests
17+
- `.well-known/aiep-platform.json` AI crawler discovery file

CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributing to AIEP Hub
2+
3+
Thank you for your interest in the Architected Instruction and Evidence Protocol.
4+
AIEP Hub is the public-facing documentation and specification portal for the AIEP platform.
5+
6+
## Getting Started
7+
8+
```bash
9+
git clone https://github.com/Phatfella/AIEP-HUB.git
10+
cd AIEP-HUB
11+
npm install
12+
npm run dev # Astro dev server on :3000
13+
```
14+
15+
## Contribution Guidelines
16+
17+
### Content Standards
18+
- All pages are Markdown with Astro frontmatter (`layout`, `title`, `description`).
19+
- Do not add inline styles — use Primer CSS classes or existing layout classes.
20+
- Navigation is driven by `src/content/nav/` — update it when adding a new page.
21+
- Every spec file carries a `classification:` frontmatter field. Do not change it without explicit instruction.
22+
23+
### Commit Conventions
24+
```
25+
feat: short description (max 72 chars)
26+
fix: short description
27+
docs: short description
28+
chore: short description
29+
```
30+
31+
### Pull Requests
32+
1. Fork the repository and create a topic branch.
33+
2. Ensure `npm run build` completes with zero errors.
34+
3. Run `npx astro check` — zero TypeScript errors required.
35+
4. Open a pull request against `main` with a clear description of the change.
36+
37+
### Filing Issues
38+
- Bug reports: include browser, OS, and steps to reproduce.
39+
- Content corrections: reference the source specification section where applicable.
40+
41+
## Governance
42+
All content is governed by the AIEP GENOME kernel.
43+
LOCKFILE_VERSION: 1.0.0 | FC: v1.0.0 | Schema: v2.0.0.
44+
45+
SPDX-License-Identifier: Apache-2.0
46+
© 2025–2026 Neil Grassby. All rights reserved.

SECURITY.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
| Version | Supported |
6+
|---------|-----------|
7+
| latest | ✅ Yes |
8+
| < 1.0 | ❌ No |
9+
10+
## Reporting a Vulnerability
11+
12+
**Please do not open a public GitHub issue for security vulnerabilities.**
13+
14+
Report security concerns to:
15+
📧 **security@aiep.protocol** (monitored — response within 72 hours)
16+
17+
Include in your report:
18+
- A description of the vulnerability and its potential impact
19+
- Steps to reproduce or proof-of-concept
20+
- The affected version(s) and component(s)
21+
22+
## Security Design Principles
23+
24+
AIEP Hub follows secure-by-default practices:
25+
26+
1. **No server-side secrets in repository**`wrangler.toml` contains only non-secret
27+
deployment configuration. Secrets are managed via Cloudflare environment variables.
28+
29+
2. **Static site** — Hub is a fully pre-rendered Astro site deployed to Cloudflare Pages.
30+
No runtime user-data handling.
31+
32+
3. **Content Security Policy** — HTTP security headers enforced by `_headers` file and
33+
Cloudflare Workers.
34+
35+
4. **Dependency hygiene**`node_modules/` is gitignored; dependencies are pinned via
36+
`package-lock.json`.
37+
38+
## Scope
39+
40+
This policy applies to the AIEP Hub Astro site and associated Cloudflare Workers.
41+
42+
Out of scope: the AIEP specification documents (`.md` files in `src/pages/`) — these are
43+
technical documents, not executable software.
44+
45+
SPDX-License-Identifier: Apache-2.0
46+
© 2025–2026 Neil Grassby. All rights reserved.

0 commit comments

Comments
 (0)