docs+ci: land #54 onboarding docs (credit MikeGatsby #63) and make CI checks real - #64
Closed
telivity-otaip wants to merge 1 commit into
Closed
docs+ci: land #54 onboarding docs (credit MikeGatsby #63) and make CI checks real#64telivity-otaip wants to merge 1 commit into
telivity-otaip wants to merge 1 commit into
Conversation
Bring in MikeGatsby's CONTRIBUTING / CoC / PR template work from #63, complete the Contributor Covenant 2.1 enforcement guidelines, add a SemVer note, and make CI match the documented local commands (`ruff check src tests scripts`) with concurrency + least-privilege permissions so same-repo PRs get real check runs. Co-authored-by: MikeGatsby <mikael.gatfi@gmail.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
2 participants
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
Lands the #54 community onboarding docs started by @MikeGatsby in #63, and fixes why PRs were showing no check runs.
Credit
@MikeGatsby authored the original CONTRIBUTING / CoC / PR template in #63. This PR continues that work with
Co-authored-by: MikeGatsbyand keeps his content as the base.We could not push directly onto the fork branch (no write access to
MikeGatsby/personality-protect), and the fork workflow is stuck on GitHub’s first-time contributor gate (conclusion: action_required). A same-repo branch is used so Actions actually run.What changed
CONTRIBUTING.md— setup, local checks, CI job names, Contoso privacy rule, SemVer note, first-time-contributor Actions noteCODE_OF_CONDUCT.md— full Contributor Covenant 2.1 including Enforcement Guidelines (Mike’s draft was a valid start; this completes it).github/PULL_REQUEST_TEMPLATE.md— checklist aligned with local+CI commands.github/workflows/ci.ymlruff check src tests scripts(wassrc testsonly — mismatched CONTRIBUTING)permissions: contents: readpull_requesttypes so runs are predictableCloses #54
Supersedes #63 (please close #63 once this is green — Mike keeps the credit)
Checks / ruleset note for maintainers
The repo ruleset currently requires a PR to merge but does not require status checks. After this lands, please add these required checks in Settings → Rules → rule “1” → Require status checks:
linttest (3.11)test (3.12)sanitizecli-smoke(This agent’s token cannot update rulesets or approve fork workflow runs.)
Local verification
ruff check src tests scripts— passpytest— 382 passedbash scripts/sanitize_check.sh— Sanitize OK