Repository navigation
docs: add contributor guide, agent instructions, architecture overview and CODEOWNERS - #49
Merged
Merged
Conversation
Every pull request and every push to main runs four jobs: - lint: ruff check and format; - typecheck: mypy; - import-contracts: import-linter; - test: pytest with coverage, plus a markdown coverage summary. The quality-gate job aggregates them and fails if any of them did not succeed. It is meant to be the only required status check. Dependabot updates uv dependencies and GitHub Actions weekly on Mondays (Europe/Rome). Minor and patch updates are grouped, and major updates arrive as separate PRs. Refs #4
…w and CODEOWNERS A new contributor can now go from cloning the repository to a merged PR by reading the repository docs alone. - CONTRIBUTING.md encodes every convention from spec section 9: - setup and the quality checks; - the board workflow and the Definition of Ready; - branch naming, Conventional Commits and the scope list; - pull request and merge rules, including the eval block for retrieval changes; - when an ADR is required; - porting from Academy; - labels and cadence. - AGENTS.md condenses the same rules for automated contributors. - docs/architecture.md gives a one-page map of the packages, layers, data flow and tracks. - CODEOWNERS routes reviews to @BitPolito/ai-ml, and ADRs to the lead maintainer. - README gains a quick start and links to the docs. Refs #5
This was referenced Oct 16, 2026
Collaborator
Author
|
Merged without an approving review by maintainer decision, to unblock contributors: this is the foundation chain everything else depends on. Verified locally on the combined chain (#1, #45, #46, #47, #49, #50 merged together, no conflicts): |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
CONTRIBUTING.mdcovers:<type>/<issue>-<desc>;gh pr merge --merge --delete-branch;AGENTS.md: the same rules, condensed for coding agents, including "stay inside the issue's scope" and "never merge your own PR".docs/architecture.md: one-page package map, engine layers, data flow, ports and tracks..github/CODEOWNERS:* @BitPolito/ai-ml, and/docs/adr/ @lucaosti.README.md: quick start and documentation links.Why
M0-4 of the backlog, so that onboarding needs nothing outside the repository.
Closes #5
How verified
main. That is how the second acceptance criterion gets checked, on the first PR opened after this merge.Reviewer notes
lint-imports, the quality gate) already exist on the base.docs/specs/anddocs/adr/resolve once docs: add design specification and initial ADRs #1 is merged.