docs: add CONTRIBUTING.md, issue templates, and PR template#10
Open
evanofficial wants to merge 2 commits into
Open
docs: add CONTRIBUTING.md, issue templates, and PR template#10evanofficial wants to merge 2 commits into
evanofficial wants to merge 2 commits into
Conversation
Scaffold the standard contributor-facing docs the repo was missing: - CONTRIBUTING.md — build/test (./gradlew :core:test, JDK 17 auto-provisioned), :core-only scope, the verify-after-write + rollback contract PRs must not weaken, the two CI jobs (core-test + fsck.fat -n oracle), the test-style pointers, the version-pinned golden-image procedure, and Apache-2.0 / DCO expectations (LICENSE / NOTICE / PROVENANCE.md). - .github/ISSUE_TEMPLATE/bug_report.md and feature_request.md. - .github/PULL_REQUEST_TEMPLATE.md with a checklist (tests added, :core test green, no weakening of the write/rollback contract without justification, goldens unchanged). Fixes #4
|
Warning
|
| Layer / File(s) | Summary |
|---|---|
CONTRIBUTING.md and PR template CONTRIBUTING.md, .github/PULL_REQUEST_TEMPLATE.md |
CONTRIBUTING.md documents build/test commands, repository scope, the write-path correctness/rollback contract, CI jobs, golden-image rules, PR style, and licensing. The PR template adds checklist items for tests, ./gradlew :core:test, scope, golden-image stability, and the correctness contract. |
Issue templates .github/ISSUE_TEMPLATE/bug_report.md, .github/ISSUE_TEMPLATE/feature_request.md |
The bug-report template prompts for reproduction steps, expected and actual behavior, environment details, and correctness-contract impact. The feature-request template prompts for summary, motivation, proposed API/change, scope check, alternatives, and additional context. |
Estimated code review effort
🎯 1 (Trivial) | ⏱️ ~5 minutes
Poem
🐇 I hopped through the repo with a clipboard bright,
Found templates and docs that felt just right.
Bugs now have prompts and PRs have a guide,
A tidy little warren for folks who abide.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
| Check name | Status | Explanation |
|---|---|---|
| Description Check | ✅ Passed | Check skipped - CodeRabbit’s high-level summary is enabled. |
| Title check | ✅ Passed | The title clearly summarizes the documentation-only changes to CONTRIBUTING.md and GitHub templates. |
| Linked Issues check | ✅ Passed | The PR adds all required docs and templates and covers the requested build, scope, rollback, CI, and provenance guidance. |
| Out of Scope Changes check | ✅ Passed | The changes stay within contributor documentation and templates with no unrelated code or feature work. |
| Docstring Coverage | ✅ Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. |
✨ Finishing Touches
🧪 Generate unit tests (beta)
- Create PR with unit tests
- Commit unit tests in branch
docs/contributor-scaffold
Comment @coderabbitai help to get the list of available commands.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/PULL_REQUEST_TEMPLATE.md:
- Line 29: The checkbox text in the pull request template uses wording that
doesn’t match the repository docs for the Android demonstrator. Update the
wording in the template to use the repo’s terminology for the Android
demonstrator instead of calling it a separate repo, keeping the scope guidance
accurate and aligned with the rest of the docs.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 0d6b5604-c21d-4f15-a446-55fa390a2704
📒 Files selected for processing (4)
.github/ISSUE_TEMPLATE/bug_report.md.github/ISSUE_TEMPLATE/feature_request.md.github/PULL_REQUEST_TEMPLATE.mdCONTRIBUTING.md
Match the README's phrasing — the Android demonstrator is 'separate and not part of this repository' — rather than asserting it is a separate repo. Addresses CodeRabbit review feedback on this PR.
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.
Closes #4.
What
Adds the standard contributor-facing scaffold the repo was missing:
CONTRIBUTING.md(repo root) — build & test (./gradlew :core:test, JDK 17 auto-provisioned via foojay-resolver),:core-only scope, the verify-after-write + rollback contract PRs must not weaken, the two CI jobs (core-test+ thefsck.fat -noracle), test-style pointers (InMemoryBlockDevice/Fat12ImageBuilder), a link to the version-pinned golden-image procedure intestdata/README.md, and Apache-2.0 / license expectations (LICENSE/NOTICE/PROVENANCE.md)..github/ISSUE_TEMPLATE/bug_report.mdandfeature_request.md— both include a "correctness-contract impact" prompt and a scope check..github/PULL_REQUEST_TEMPLATE.md— checklist: tests added,:coretest green, no weakening of the write/rollback contract without justification, goldens unchanged, one focused change.Notes
ci.yml,testdata/README.md, and license files rather than generic boilerplate.CONTRIBUTING.mdencodes project conventions — this is a starting draft, so edit anything that doesn't match how you want the project run. The issue/PR templates are the more newcomer-oriented part.Summary by CodeRabbit
Documentation
Chores