fix: resolve all issues from #26 — deps, badges, CODEOWNERS, branch refs, duplicate dir - #29
fix: resolve all issues from #26 — deps, badges, CODEOWNERS, branch refs, duplicate dir#29mr-adonis-jimenez wants to merge 6 commits into
Conversation
…github/dependabot.yml is canonical)
There was a problem hiding this comment.
Code Review
This pull request updates the repository's configuration and documentation. Key changes include transitioning branch references from 'master' to 'main' in CONTRIBUTING.md and README.md, consolidating the CODEOWNERS file under a single owner, and expanding the requirements.txt file with categorized core and development dependencies. Additionally, the README.md was updated with new badges and refined architecture details, while obsolete configuration files were removed. I have no feedback to provide.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 931a70e58e
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ### Enable repository git hooks (recommended) | ||
|
|
||
| This repo includes a `pre-push` hook to prevent direct pushes to the protected `master` branch. | ||
| This repo includes a `pre-push` hook to prevent direct pushes to the protected `main` branch. |
There was a problem hiding this comment.
Correct protected branch name in hook guidance
The updated docs now state that the local pre-push hook blocks pushes to main, but scripts/git-hooks/pre-push still hard-codes refs/heads/master. In this state, contributors who follow CONTRIBUTING.md can still push directly to main, so the branch-protection guidance is inaccurate and creates a false sense of enforcement.
Useful? React with 👍 / 👎.
Closes #26
Addresses all 5 issues from the report:
1. ✅ requirements.txt synced with pyproject.toml
Added missing
numpy,python-multipart, and all dev deps (pytest-cov,pytest-asyncio,black,flake8,isort,pylint). Split into clear Core / Dev sections with comments.2. ✅ README badges fixed
(this is a Python project, not npm)with the actual CI badge pointing toci-cd.ymlin this repo3. ✅ CODEOWNERS moved to correct location
.github/CODEOWNERS(no.mdextension) — GitHub now recognizes it for code ownershipCODEOWNERS.md@mr-adonis-jimenez(removed placeholder team references)4. ✅
master→mainbranch referencesREADME.mdandCONTRIBUTING.mdto referencemainthroughout5. ✅ Duplicate
GitHub/directory cleaned upGitHub/dependabot.yml— it was a stale npm config duplicating the proper.github/dependabot.yml(which covers pip, GitHub Actions, and Docker)GitHub/directory is now empty and will be removed from the tree