diff --git a/.agentready/config/.agentready-config.yaml b/.agentready/config/.agentready-config.yaml new file mode 100644 index 000000000..c959ad546 --- /dev/null +++ b/.agentready/config/.agentready-config.yaml @@ -0,0 +1,20 @@ +excluded_attributes: + # Not applicable to this Python API service + - dbt_project_config + - dbt_model_documentation + - dbt_data_tests + - dbt_project_structure + - container_setup + - progressive_disclosure + # Requires GitHub API integration — cannot be assessed from repo contents + - branch_protection + # False positive: pip-compile --generate-hashes format misread as unpinned deps + - lock_files + # False positive: tox-based quality gates (black, flake8, mypy, pytest) not + # recognised by agentready's keyword pattern matching on CI job names + - ci_quality_gates + # Blocked: AGENTS.md is CI-enforced to ≤60 lines; single-file commands cannot + # be added without breaching that limit + - single_file_verification + # External optional tool; not a meaningful quality gate for this project + - repomix_config diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..4a7373b60 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,27 @@ +--- +name: Bug report +about: Report a reproducible bug in IIB +title: '[BUG] ' +labels: bug +assignees: '' +--- + +**Describe the bug** +A clear description of what is broken. + +**Request type** +Which IIB request type is affected? (add / rm / merge-index-image / regenerate-bundle / fbc-operations / create-empty-index) + +**To reproduce** +Steps or minimal API call to reproduce the behaviour. + +**Expected behaviour** +What should have happened instead. + +**Logs / error output** +Paste relevant API or worker log lines (redact tokens and credentials). + +**Environment** +- IIB version / commit: +- OpenShift / OCP version: +- OPM version: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..37ee20ae9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature request +about: Propose a new capability or improvement +title: '[FEATURE] ' +labels: enhancement +assignees: '' +--- + +**Problem / motivation** +What problem does this solve? Who is affected? + +**Proposed solution** +Describe the change you'd like to see, including any new API endpoints or request types. + +**Alternatives considered** +Other approaches you explored and why they were rejected. + +**Additional context** +Relevant upstream issues, RFCs, or related PRs. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..2c5e1e4fb --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,21 @@ +## Summary + + + +Fixes # + +## Type of change + +- [ ] Bug fix +- [ ] New feature / request type +- [ ] Refactor +- [ ] Documentation +- [ ] CI / tooling + +## Checklist + +- [ ] Unit tests added or updated (`tox -e py312`) +- [ ] All tests and linters pass (`tox`) +- [ ] New Alembic migration created if models changed (never edit existing migrations) +- [ ] API ↔ Worker task signatures kept in sync if task args changed +- [ ] CHANGELOG.md updated if user-visible behaviour changes diff --git a/.github/workflows/agentready.yaml b/.github/workflows/agentready.yaml new file mode 100644 index 000000000..60dfcadbd --- /dev/null +++ b/.github/workflows/agentready.yaml @@ -0,0 +1,27 @@ +--- +name: AgentReady Assessment + +on: + pull_request: + branches: [main] + +jobs: + agentready: + name: Check repo with agentready + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6 + + - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 + with: + python-version: '3.12' + + - name: Install agentready + run: python -m pip install agentready==2.35.1 + + - name: Run agentready check + run: | + agentready --version + agentready assess --config "${GITHUB_WORKSPACE}"/.agentready/config/.agentready-config.yaml . diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100755 index 000000000..90570ee84 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,19 @@ +repos: + - repo: https://github.com/psf/black + rev: 22.3.0 + hooks: + - id: black + args: [--line-length, "100", --skip-string-normalization] + + - repo: https://github.com/PyCQA/flake8 + rev: 7.3.0 + hooks: + - id: flake8 + args: [--max-line-length, "100", --ignore, "D100,D104,D105,W503"] + + - repo: https://github.com/compilerla/conventional-pre-commit + rev: v4.0.0 + hooks: + - id: conventional-pre-commit + stages: [commit-msg] + args: [feat, fix, docs, style, refactor, test, chore, ci, build, perf]