EdisonJwa
f1bc9a6c85
Imports the v0.9.2 documentation baseline and the bootstrap files required by docs/governance/repository-bootstrap-plan.md v0.1.0 §3, minus the justfile (added in the next commit). This commit establishes the git history for the project. All previous work lived only as filesystem state with no version control.
73 lines
1.8 KiB
Markdown
73 lines
1.8 KiB
Markdown
# Repository Bootstrap Plan
|
|
|
|
**Document type:** Governance / Repository Bootstrap Plan
|
|
**Version:** 0.1.0
|
|
**Status:** Draft
|
|
**Language:** English
|
|
**Product:** Chanora
|
|
**Repo path:** `docs/governance/repository-bootstrap-plan.md`
|
|
|
|
---
|
|
|
|
## 1. Purpose
|
|
|
|
This document defines the files and directories that should exist before product implementation begins.
|
|
|
|
## 2. Bootstrap Scope
|
|
|
|
This bootstrap package intentionally excludes CI workflow files.
|
|
|
|
The goal is to establish:
|
|
|
|
- repository metadata;
|
|
- contributor guidance;
|
|
- security policy;
|
|
- changelog;
|
|
- license placeholder;
|
|
- notice placeholder;
|
|
- editor and ignore rules;
|
|
- local command placeholders;
|
|
- documentation validation script;
|
|
- future scaffold plan.
|
|
|
|
## 3. Required Root Files
|
|
|
|
| File | Purpose |
|
|
|---|---|
|
|
| `README.md` | App/project overview |
|
|
| `CONTRIBUTING.md` | Contribution rules |
|
|
| `SECURITY.md` | Security reporting and security gates |
|
|
| `CHANGELOG.md` | Release/change history |
|
|
| `LICENSE` | License placeholder until final license decision |
|
|
| `NOTICE` | Non-affiliation and attribution placeholder |
|
|
| `.editorconfig` | Editor formatting baseline |
|
|
| `.gitignore` | Ignore rules |
|
|
| `.env.example` | Safe local environment template |
|
|
| `justfile` | Local command entrypoint |
|
|
|
|
## 4. Required Tooling Files
|
|
|
|
| File | Purpose |
|
|
|---|---|
|
|
| `tools/validate_docs.py` | Local documentation and traceability validation |
|
|
|
|
## 5. Future Work
|
|
|
|
CI workflow files should be added later after this bootstrap is committed and the repo structure is accepted.
|
|
|
|
Recommended later CI files:
|
|
|
|
```text
|
|
.github/workflows/docs.yml
|
|
.github/workflows/repo-health.yml
|
|
.github/workflows/flutter.yml
|
|
.github/workflows/rust.yml
|
|
.github/workflows/security.yml
|
|
```
|
|
|
|
## 6. Change History
|
|
|
|
| Version | Date | Description |
|
|
|---|---|---|
|
|
| 0.1.0 | 2026-05-14 | Initial repository bootstrap plan excluding CI. |
|