Skip to content

Add contributor guidelines (CONTRIBUTING.md + PR template)#99

Merged
dfederm merged 1 commit into
mainfrom
dfederm/jellybox-contributor-guidelines
Jun 21, 2026
Merged

Add contributor guidelines (CONTRIBUTING.md + PR template)#99
dfederm merged 1 commit into
mainfrom
dfederm/jellybox-contributor-guidelines

Conversation

@dfederm

@dfederm dfederm commented Jun 21, 2026

Copy link
Copy Markdown
Owner

Summary

Adds human-facing contribution guidance for JellyBox so future PRs are easier to scope, validate, and review. This is a docs-only change: it adds CONTRIBUTING.md and .github/PULL_REQUEST_TEMPLATE.md with no source changes and no build impact.

What's included

  • Guidance to keep PRs single-purpose and reviewable.
  • The expected MSBuild validation gate: x64 build, restore-on-build, and 0 warnings/0 errors as the bar because there are no automated tests.
  • Manual testing expectations for UI, playback, and controller changes, including the platform tested.
  • PR description expectations, including screenshots or recordings for UI changes.
  • Key project conventions documented inline for human contributors, including UWP-not-WinUI3 and central package management.

Validation

Docs-only change, so no build or test gate was run. Concrete repo claims were checked against the existing project configuration and guidance, including .github/copilot-instructions.md, .github/workflows/build.yml, Directory.Build.rsp, Directory.Packages.props, and JellyBox.sln.

Add a root CONTRIBUTING.md and a pull request template covering: single-purpose PRs; the 0-warning build as the only validation gate (there are no automated tests); manual testing of UI/playback/controller changes with the tested platform declared (real Xbox preferred, Windows acceptable); and PR descriptions with screenshots or recordings for UI changes. The guidelines are self-contained so contributors aren't routed to the AI-focused .github/copilot-instructions.md.
@dfederm dfederm merged commit e754838 into main Jun 21, 2026
1 check passed
@dfederm dfederm deleted the dfederm/jellybox-contributor-guidelines branch June 21, 2026 06:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant