repo setup
This commit is contained in:
parent
ce94fdacaa
commit
3a357dc862
2
.gitattributes
vendored
2
.gitattributes
vendored
|
|
@ -1,2 +0,0 @@
|
||||||
# Auto detect text files and perform LF normalization
|
|
||||||
* text=auto
|
|
||||||
30
.gitignore
vendored
Normal file
30
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,30 @@
|
||||||
|
# Secrets
|
||||||
|
*.key
|
||||||
|
*.pem
|
||||||
|
*.env
|
||||||
|
.env*
|
||||||
|
.secrets/
|
||||||
|
credentials.txt
|
||||||
|
.ssh/
|
||||||
|
|
||||||
|
# OS
|
||||||
|
Thumbs.db
|
||||||
|
.DS_Store
|
||||||
|
ConsoleHost_history.txt
|
||||||
|
|
||||||
|
# IDE
|
||||||
|
.vscode/
|
||||||
|
|
||||||
|
# Temporary
|
||||||
|
*.log
|
||||||
|
*.tmp
|
||||||
|
*.bak
|
||||||
|
*.old
|
||||||
|
|
||||||
|
# Python
|
||||||
|
__pycache__/
|
||||||
|
*.pyc
|
||||||
|
.venv/
|
||||||
|
|
||||||
|
# Node
|
||||||
|
node_modules/
|
||||||
7
PROJECTRULES.md
Normal file
7
PROJECTRULES.md
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
# Project Rules
|
||||||
|
|
||||||
|
1. Never modify production database schemas without migration scripts.
|
||||||
|
2. Update documentation when architecture changes.
|
||||||
|
3. Follow directory structure strictly.
|
||||||
|
4. Do not place business logic in API controllers.
|
||||||
|
5. All new features require tests.
|
||||||
29
README.md
Normal file
29
README.md
Normal file
|
|
@ -0,0 +1,29 @@
|
||||||
|
Create a root README.md that explains the repo.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
# Project Name
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
What the system does.
|
||||||
|
|
||||||
|
## Architecture Overview
|
||||||
|
High level explanation.
|
||||||
|
|
||||||
|
## Repository Structure
|
||||||
|
|
||||||
|
repo/
|
||||||
|
docs/
|
||||||
|
src/
|
||||||
|
data/
|
||||||
|
tests/
|
||||||
|
ops/
|
||||||
|
|
||||||
|
## Development Workflow
|
||||||
|
|
||||||
|
1. Edit docs
|
||||||
|
2. Generate code
|
||||||
|
3. Run tests
|
||||||
|
4. Deploy
|
||||||
|
|
||||||
|
This becomes the entry point for AI tools.
|
||||||
3
VERSION.md
Normal file
3
VERSION.md
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
v0.x = experimental
|
||||||
|
v1.x = stable production
|
||||||
|
v2.x = major architecture change
|
||||||
1
docs/agents.md
Normal file
1
docs/agents.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
vision-strategy.md
|
||||||
1
docs/api-spec.md
Normal file
1
docs/api-spec.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
api-spec.md
|
||||||
1
docs/architecture.md
Normal file
1
docs/architecture.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
environments.md
|
||||||
1
docs/build-plan.md
Normal file
1
docs/build-plan.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
api-spec.md
|
||||||
1
docs/data-model.md
Normal file
1
docs/data-model.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
api-spec.md
|
||||||
1
docs/decisions.md
Normal file
1
docs/decisions.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
api-spec.md
|
||||||
1
docs/environments.md
Normal file
1
docs/environments.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
data-model.md
|
||||||
1
docs/system.md
Normal file
1
docs/system.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
api-spec.md
|
||||||
1
docs/user-flows.md
Normal file
1
docs/user-flows.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
architecture.md
|
||||||
1
docs/vision-strategy.md
Normal file
1
docs/vision-strategy.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
user-flows.md
|
||||||
Loading…
Reference in New Issue
Block a user