Skip to content

feat: enchache pull request templates - #31

Open
indpriyanshuraj wants to merge 1 commit into
wo55555:developfrom
indpriyanshuraj:feat/enchace-pull-request-templates
Open

feat: enchache pull request templates#31
indpriyanshuraj wants to merge 1 commit into
wo55555:developfrom
indpriyanshuraj:feat/enchace-pull-request-templates

Conversation

@indpriyanshuraj

Copy link
Copy Markdown
Contributor

Summary

Improve Playback's pull request templates by keeping the existing general-purpose template as a safe fallback and adding specialized templates for common contribution types.

The new structure provides more relevant guidance for bug fixes, features, performance optimizations, compatibility changes, documentation updates, and translations without making the general PR template unnecessarily large.

Changes

📝 .github/PULL_REQUEST_TEMPLATE.md

  • Refined the general-purpose template while keeping it minimal.
  • Added clearer comments explaining what contributors should provide.
  • Added guidance to only check completed validation items.
  • Added optional issue-reference guidance without requiring an issue for every PR.
  • Expanded runtime-testing guidance to cover recording, replay, camera, export, and UI behavior.
  • Kept the existing project-specific compatibility, replay, formatting, localization, licensing, and privacy checks.

🐛 .github/PULL_REQUEST_TEMPLATE/bug-fix.md

  • Added a dedicated bug-fix template.
  • Added reproduction conditions and steps, with support for referencing an existing issue instead of duplicating its details.
  • Added root-cause and solution sections.
  • Added bug-specific validation guidance.
  • Retained Playback-specific compatibility and replay-impact information.

.github/PULL_REQUEST_TEMPLATE/feature.md

  • Added a dedicated feature template.
  • Separates the feature purpose from the implementation changes.
  • Includes validation and compatibility/replay-impact sections.
  • Keeps the existing focused-change, formatting, localization, licensing, and privacy checks.

.github/PULL_REQUEST_TEMPLATE/performance.md

  • Added a dedicated performance optimization template.
  • Requires contributors to explain why the change should improve performance rather than relying only on benchmark numbers.
  • Added an optional benchmark/profiling section.
  • Benchmark reporting is explicitly optional, with a checkbox only for contributors who provide measurements.
  • Added guidance to describe the workload, environment, before/after results, and measurement method when benchmarks are provided.
  • Added optional GitHub Discussion referencing for performance investigations or design decisions.

🔗 .github/PULL_REQUEST_TEMPLATE/compatibility.md

  • Added a dedicated compatibility template.
  • Captures affected Minecraft, LeviLamina, and Playback versions.
  • Adds a dedicated compatibility-change section.
  • Adds explicit replay-impact guidance covering existing replay archives, newly recorded data, replay readability, and format/configuration changes.
  • Adds validation guidance for version-specific testing.
  • Added optional GitHub Discussion referencing for compatibility investigations and design decisions.

📚 .github/PULL_REQUEST_TEMPLATE/documentation.md

  • Added a documentation-specific template.
  • Replaces code-oriented validation with documentation-relevant checks such as links, paths, commands, examples, and consistency with current behavior.
  • Avoids requiring a build for documentation-only changes.

🌐 .github/PULL_REQUEST_TEMPLATE/translation.md

  • Added a translation-specific template.
  • Captures affected languages and localization changes.
  • Adds checks for translation-key alignment, placeholders, formatting, untranslated strings, spelling, and grammar.
  • Reflects Playback's separate native UI/command and resource-pack localization layers.

Template design

  • Instructions are kept in HTML comments so they do not appear in submitted PRs.
  • Checkboxes remain visible so contributors explicitly confirm completed checks.
  • Templates avoid pre-filled factual claims that could remain incorrect when a contributor opens a PR without editing the template.
  • Specialized templates add information relevant to the change type instead of duplicating the complete general template.
  • Build/CI work does not receive a dedicated template because those changes are infrequent and can use the general template.

Validation

  • Reviewed the existing Playback pull request workflow and CONTRIBUTING.md.
  • Checked that the specialized templates match Playback's current build, testing, localization, compatibility, and replay requirements.
  • Verified that the templates remain usable as Markdown/GitHub PR templates.
  • git diff --check

Checklist

  • The change is focused and contains no unrelated refactoring.
  • Template instructions are written as comments where they should not appear in submitted PRs.
  • Validation checkboxes do not imply tests were performed when they were not.
  • Playback-specific replay, compatibility, localization, licensing, and privacy requirements remain covered.
  • No third-party code or assets were introduced.
  • No private server or player information is included.

Note

The general template remains the default fallback. Specialized templates are intended for PRs where additional context materially helps review rather than requiring contributors to select a template for every possible change category.

Signed-off-by: indpriyanshuraj <243560345+indpriyanshuraj@users.noreply.github.com>
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