docs: repository settings guidelines - #4
Merged
Conversation
3 tasks
Contributor
Author
Capture the recommended common pattern for first-party repo defaults, branch protection, Dependabot/security, forks, and github-workflows CI. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Cross-link the open PROJECT_SETUP PR so settings guidance points at agent-skills / agent-workspace review for new and existing repos. Co-authored-by: Cursor <cursoragent@cursor.com>
Org is one maintainer; prefer 0 required reviews and soft admin enforcement so automation stays usable without multi-reviewer gates. Co-authored-by: Cursor <cursoragent@cursor.com>
surrealwolf
force-pushed
the
docs/repo-settings-guidelines
branch
from
August 2, 2026 17:56
10ccc4e to
853d90c
Compare
Remove stale PR #5 README row and link PROJECT_SETUP/NAMING in-repo after main catch-up. Co-authored-by: Cursor <cursoragent@cursor.com>
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
1 participant
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.
Summary
docs/REPO_SETTINGS.md: recommended common pattern for first-party repo defaults, branch protection / rulesets, Dependabot & vulnerability alerts, fork exceptions, and how this ties togithub-workflowsreusable CIenforce_admins(off) so the sole maintainer is not locked out — plus a short When the org grows sectiondelete_branch_on_mergeon, wiki off;mainclassic protection aligned to the solo-dev pattern (0 reviews, no empty required checks,enforce_adminsoff)Alignment gaps (audit)
maindefault; issues/projects on; merge strategies on; downloads off; many public repos share classic protection (PR required, often 0 approvals, linear history, no force push)enforce_adminson (solo default prefers off); private repos cannot use classic protection on free plan; forks correctly differ (issues off)Test plan
docs/REPO_SETTINGS.mdfor solo-dev clarity and org-mission tone.githubmainprotection matches the documented solo patternNote
Low Risk
Documentation-only changes in the org meta repo; no application code or automated org-wide settings changes in the diff.
Overview
Introduces
docs/REPO_SETTINGS.mdas the canonical target pattern for first-party DataKnifeAI repos: creation defaults (e.g.main, issues on, wiki off, squash + delete branch on merge), solo-maintainer branch protection (PR required, 0 approvals, linear history, no force-push; real CI checks only; softenforce_admins), optional rulesets, Dependabot/vuln alerts, fork exceptions, and how settings tie to pinnedgithub-workflowsreusable CI.The doc also records an alignment snapshot from an org audit (common drift vs. target) and a safe rollout approach—document intent first, no bulk product-repo changes in this PR.
The root README table gains a row pointing to the new doc.
Reviewed by Cursor Bugbot for commit f6d7596. Bugbot is set up for automated code reviews on this repo. Configure here.