aitbc1
da3d1ff042
Some checks failed
AITBC CI/CD Pipeline / lint-and-test (3.11) (pull_request) Has been cancelled
AITBC CI/CD Pipeline / lint-and-test (3.12) (pull_request) Has been cancelled
AITBC CI/CD Pipeline / lint-and-test (3.13) (pull_request) Has been cancelled
Security Scanning / Bandit Security Scan (apps/coordinator-api/src) (pull_request) Has been cancelled
Security Scanning / Bandit Security Scan (cli/aitbc_cli) (pull_request) Has been cancelled
Security Scanning / Bandit Security Scan (packages/py/aitbc-core/src) (pull_request) Has been cancelled
Security Scanning / Bandit Security Scan (packages/py/aitbc-crypto/src) (pull_request) Has been cancelled
Security Scanning / Bandit Security Scan (packages/py/aitbc-sdk/src) (pull_request) Has been cancelled
Security Scanning / Bandit Security Scan (tests) (pull_request) Has been cancelled
Security Scanning / CodeQL Security Analysis (javascript) (pull_request) Has been cancelled
Security Scanning / CodeQL Security Analysis (python) (pull_request) Has been cancelled
Security Scanning / Dependency Security Scan (pull_request) Has been cancelled
Security Scanning / Container Security Scan (pull_request) Has been cancelled
Security Scanning / OSSF Scorecard (pull_request) Has been cancelled
AITBC CI/CD Pipeline / test-cli (pull_request) Has been cancelled
AITBC CI/CD Pipeline / test-services (pull_request) Has been cancelled
AITBC CI/CD Pipeline / test-production-services (pull_request) Has been cancelled
AITBC CI/CD Pipeline / security-scan (pull_request) Has been cancelled
AITBC CI/CD Pipeline / build (pull_request) Has been cancelled
AITBC CI/CD Pipeline / deploy-staging (pull_request) Has been cancelled
AITBC CI/CD Pipeline / deploy-production (pull_request) Has been cancelled
AITBC CI/CD Pipeline / performance-test (pull_request) Has been cancelled
AITBC CI/CD Pipeline / docs (pull_request) Has been cancelled
AITBC CI/CD Pipeline / release (pull_request) Has been cancelled
AITBC CI/CD Pipeline / notify (pull_request) Has been cancelled
Security Scanning / Security Summary Report (pull_request) Has been cancelled
- Add Gitea issue template (agent_task.md) - Provide create_structured_issue.py utility - Document standards in ai-memory/knowledge/coding-standards.md This ensures issues are machine-readable and consistently scoped.
28 lines
1.2 KiB
Markdown
28 lines
1.2 KiB
Markdown
# Coding Standards
|
|
|
|
## Issue Creation
|
|
All agents must create issues using the **structured template**:
|
|
- Use the helper script `scripts/create_structured_issue.py` or manually follow the `.gitea/ISSUE_TEMPLATE/agent_task.md` template.
|
|
- Include all required fields: Task, Context, Expected Result, Files Likely Affected, Suggested Implementation, Difficulty, Priority, Labels.
|
|
- Prefer small, scoped tasks. Break large work into multiple issues.
|
|
|
|
## Code Style
|
|
- Follow PEP 8 for Python.
|
|
- Use type hints.
|
|
- Handle exceptions specifically (avoid bare `except:`).
|
|
- Replace `print()` with `logging` in library code.
|
|
|
|
## Commits
|
|
- Use Conventional Commits: `feat:`, `fix:`, `refactor:`, `docs:`, `test:`, `chore:`.
|
|
- Reference issue numbers in commit bodies (`Fixes #123`).
|
|
|
|
## PR Reviews
|
|
- Review for security, performance, and readability.
|
|
- Ensure PR passes tests and lint.
|
|
- Approve according to stability rings (Ring 0 requires manual review by a human; Ring 1+ may auto-approve after syntax validation).
|
|
|
|
## Memory Usage
|
|
- Record architectural decisions in `ai-memory/decisions/architectural-decisions.md`.
|
|
- Log daily work in `ai-memory/daily/YYYY-MM-DD.md`.
|
|
- Append new failure patterns to `ai-memory/failures/failure-archive.md`.
|