Add contributing workflow and expand gitignore
This commit is contained in:
29
.gitignore
vendored
29
.gitignore
vendored
@@ -1,17 +1,38 @@
|
|||||||
|
# Dependencies
|
||||||
node_modules/
|
node_modules/
|
||||||
.pnpm-store/
|
.pnpm-store/
|
||||||
.next/
|
|
||||||
|
# Build output
|
||||||
dist/
|
dist/
|
||||||
build/
|
build/
|
||||||
|
.next/
|
||||||
|
out/
|
||||||
|
*.tsbuildinfo
|
||||||
|
|
||||||
|
# Test output
|
||||||
coverage/
|
coverage/
|
||||||
|
.nyc_output/
|
||||||
|
|
||||||
|
# Runtime and temp files
|
||||||
|
*.log
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
pnpm-debug.log*
|
||||||
|
.tmp/
|
||||||
|
tmp/
|
||||||
|
temp/
|
||||||
|
|
||||||
|
# Environment files
|
||||||
.env
|
.env
|
||||||
.env.local
|
.env.local
|
||||||
.env.*.local
|
.env.*.local
|
||||||
*.log
|
|
||||||
|
# IDE and OS files
|
||||||
.DS_Store
|
.DS_Store
|
||||||
.vscode/
|
.vscode/
|
||||||
.idea/
|
.idea/
|
||||||
.tmp/
|
|
||||||
tmp/
|
# Local databases
|
||||||
packages/db/prisma/dev.db
|
packages/db/prisma/dev.db
|
||||||
packages/db/prisma/dev.db-journal
|
packages/db/prisma/dev.db-journal
|
||||||
|
|||||||
33
CONTRIBUTING.md
Normal file
33
CONTRIBUTING.md
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
# Contributing
|
||||||
|
|
||||||
|
## Branching Rule
|
||||||
|
- Direct pushes to `master` are forbidden.
|
||||||
|
- Every task must be implemented in a separate branch.
|
||||||
|
- Finished work must be delivered through a merge request into `master`.
|
||||||
|
|
||||||
|
## Standard Flow
|
||||||
|
1. Update local `master`.
|
||||||
|
2. Create a task branch from `master`.
|
||||||
|
3. Implement the change in that branch.
|
||||||
|
4. Run the relevant verification for the change.
|
||||||
|
5. Commit the work in that branch.
|
||||||
|
6. Push the branch to Gitea.
|
||||||
|
7. Open a merge request into `master`.
|
||||||
|
8. Merge only after review or explicit approval.
|
||||||
|
|
||||||
|
## Branch Naming
|
||||||
|
Use short, purpose-driven names, for example:
|
||||||
|
- `feature/auth-password-reset`
|
||||||
|
- `fix/session-revoke`
|
||||||
|
- `docs/deployment-notes`
|
||||||
|
- `chore/gitignore`
|
||||||
|
|
||||||
|
## Minimum Expectations
|
||||||
|
- Keep changes scoped to one task per branch.
|
||||||
|
- Do not mix unrelated refactors into the same merge request.
|
||||||
|
- Update docs when behavior, deployment, or operational flow changes.
|
||||||
|
- If schema changes are introduced, include the Prisma migration in the same branch.
|
||||||
|
|
||||||
|
## Agent Workflow
|
||||||
|
- Codex or any other coding agent must create and use a dedicated branch per task.
|
||||||
|
- After task completion, the agent should push that branch and prepare it for a merge request instead of pushing directly to `master`.
|
||||||
@@ -28,3 +28,4 @@ The repository is intentionally light on runtime code. Its current purpose is to
|
|||||||
- `docs/plan/mvp-system-plan.md`
|
- `docs/plan/mvp-system-plan.md`
|
||||||
- `docs/architecture/system-overview.md`
|
- `docs/architecture/system-overview.md`
|
||||||
- `docs/ops/deployment.md`
|
- `docs/ops/deployment.md`
|
||||||
|
- `CONTRIBUTING.md`
|
||||||
|
|||||||
Reference in New Issue
Block a user