Skip to content

Add GitHub issue and pull-request templates #38

Description

@SamratB8

Summary

Create GitHub issue templates and a pull-request template for WinDroid Runtime.

The templates should help contributors submit complete, actionable reports without making the contribution process overly bureaucratic.

Templates must also remind contributors about the project’s legal and security boundaries.

Background

WinDroid Runtime is intended to accept contributions across:

  • C# and .NET
  • WinUI 3
  • ADB tooling
  • Android internals
  • Runtime research
  • Virtualization research
  • Documentation
  • Security

Structured templates will make reports easier to understand and reduce repeated clarification.

Proposed Structure

.github/
├── ISSUE_TEMPLATE/
│   ├── bug-report.yml
│   ├── feature-request.yml
│   ├── research-proposal.yml
│   └── config.yml
└── pull_request_template.md

GitHub issue forms in YAML are preferred where practical.

Bug Report Template

The bug-report form should request:

  • Short description
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • WinDroid Runtime version or commit
  • Windows version
  • .NET SDK version
  • ADB version where relevant
  • Connected device or emulator details where relevant
  • Relevant logs
  • Additional context

Include reminders to:

  • Remove personal information
  • Remove authentication tokens
  • Remove private device identifiers where unnecessary
  • Avoid posting security vulnerabilities publicly

Security vulnerabilities should be directed to SECURITY.md.

Feature Request Template

The feature-request form should request:

  • Problem being solved
  • Proposed behavior
  • User impact
  • Possible implementation area
  • Alternatives considered
  • Whether the requester is willing to contribute
  • Additional context

The form should distinguish actionable features from broad discussion.

Large or uncertain proposals may be directed to GitHub Discussions first.

Research Proposal Template

The research-proposal form should be suitable for:

  • AOSP research
  • Virtualization research
  • Hyper-V or Windows Hypervisor Platform
  • QEMU research
  • Android image booting
  • Graphics, input, audio, networking, and file bridges
  • Windows integration research

Request:

  • Research question
  • Motivation
  • Known references
  • Proposed experiment
  • Expected output
  • Risks
  • Legal or licensing considerations
  • Hardware requirements
  • Whether code changes are expected

The template must make clear that a research proposal is not automatically an approved implementation plan.

Pull-Request Template

The pull-request template should request:

  • Summary
  • Linked issue
  • Type of change
  • Implementation notes
  • Testing performed
  • Screenshots for UI changes
  • Known limitations
  • Checklist

Suggested checklist:

- [ ] I linked the relevant issue.
- [ ] I kept the change within the issue scope.
- [ ] I built the solution in Debug configuration.
- [ ] I built the solution in Release configuration.
- [ ] I added or updated tests where appropriate.
- [ ] I did not commit secrets, certificates, or local build output.
- [ ] I did not include proprietary WSA, Google, Microsoft, Amazon, or app-store binaries.
- [ ] I updated documentation where necessary.

Legal Boundary Reminder

Templates should remind contributors that WinDroid Runtime must not include:

  • Microsoft WSA binaries
  • Proprietary Microsoft components copied from WSA
  • Google Play Store binaries
  • Google Mobile Services binaries without authorization
  • Amazon Appstore proprietary binaries
  • Private SDKs or files without redistribution permission
  • Third-party code copied without license compliance
  • Trademark usage suggesting official affiliation

Keep the reminder concise and link to the repository’s legal documentation.

Security Reminder

Templates should remind contributors:

  • Do not publish exploitable security vulnerabilities in normal issues
  • Follow SECURITY.md
  • Remove secrets and sensitive information from logs
  • Do not commit signing keys or certificates
  • Do not attach private user data

Tasks

  • Create bug-report issue form
  • Create feature-request issue form
  • Create research-proposal issue form
  • Create issue-template configuration
  • Create pull-request template
  • Link security reports to SECURITY.md
  • Link research discussion to GitHub Discussions where appropriate
  • Add legal-boundary reminders
  • Add secret and sensitive-data reminders
  • Keep language clear and beginner-friendly
  • Validate all YAML forms
  • Test the forms in GitHub’s new-issue interface

Out of Scope

This issue does not need to:

  • Add automated issue triage
  • Add bots
  • Add automatic labeling
  • Add stale-issue automation
  • Add contribution license agreements
  • Add organization-wide templates
  • Add a code-of-conduct enforcement system
  • Create GitHub Projects boards
  • Create release templates

Acceptance Criteria

  • A bug-report template is available.
  • A feature-request template is available.
  • A research-proposal template is available.
  • A pull-request template is available.
  • Bug reports request reproduction and environment details.
  • Feature requests identify the problem being solved.
  • Research proposals request legal and technical considerations.
  • PRs request linked issues and testing information.
  • Templates direct private security reports to SECURITY.md.
  • Templates warn against posting secrets or private data.
  • Templates remind contributors about proprietary-binary restrictions.
  • YAML issue forms are valid.
  • Templates are clear and not unnecessarily bureaucratic.
  • A new contributor can understand what information to provide.

Metadata

Metadata

Assignees

No one assigned

    Labels

    communityContributor experience, discussions, project participation, governance, and community resources.documentationImprovements or additions to documentationgood first issueGood for newcomersphase-1Work planned for the first development phase and initial usable project foundation.

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    Status
    Ready

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions