Issues and pull requests

Creating an issue

Use issues to track bugs, feature requests, or any task related to your app:

1. Go to your repository and click the "Issues" tab.
2. Click "New issue."
3. Give your issue a clear title. Examples: "Login button not responding on mobile", "Add dark mode support", "Refactor API calls"
4. Describe the issue in detail. Include steps to reproduce (for bugs) or expected behavior (for features).
5. Assign labels if relevant. See below for label semantics.
6. Click "Create issue."

Creating a pull request

Use pull requests to propose changes to your code. Other team members (or yourself) can review and discuss before merging:

1. Create a new branch with your changes:

   git checkout -b feature/new-feature
   git commit -m "Add new feature"
   git push -u origin feature/new-feature

2. Go to your repository and click the "Pull requests" tab.
3. Click "New pull request."
4. Select the branch you're merging from (your feature branch) and the branch you're merging into (usually "main").
5. Write a descriptive title and description. Explain what your PR changes and why.
6. Request reviewers if applicable. Add team members or maintainers to review.
7. Click "Create pull request."

Reviewing and merging

Once a PR is created:

• Reviewers can comment on specific lines of code or the PR as a whole.
• The author can push new commits to address feedback. The PR updates automatically.
• Once approved, merge the PR. Click the "Merge" button to integrate the changes into the main branch.

Labels and their meanings

Labels help organize issues and PRs:

Standard labels

• bug: Something is broken or not working as intended.
• enhancement: A new feature or improvement to existing functionality.
• documentation: Updates or improvements to docs, comments, or README files.
• wontfix: A decision has been made not to address this issue or PR.
• duplicate: This issue or PR is a duplicate of another.
• help wanted: The maintainer is looking for community contributions on this issue.

Platform-escalated issues

platform-escalation: This label indicates that an issue originated from ${brand.name} storefront support tickets or platform operations. These are cross-surface escalations:

• Source: A buyer reported a problem on the storefront, or the platform team flagged a critical issue.
• Action required: These issues usually need urgent attention from the app developer.
• Example: "App crashes on Windows 11" or "License key not validating."

When you see the platform-escalation label, treat it as higher priority. The platform team is tracking the issue and may follow up with you.

Issue and PR status

• Open: Active and awaiting action.
• In Progress: Someone is actively working on it.
• Closed: Resolved or dismissed.

Best practices

When creating an issue:

• Be specific. "Login doesn't work" is unclear. "Login button returns 403 Forbidden on Firefox 115" is actionable.
• Provide steps to reproduce. Include example data or screenshots if helpful.
• Include your environment. OS, browser version, app version, etc.

When creating a PR:

• Keep it focused. One PR = one feature or fix. Avoid mixing multiple changes.
• Write a clear description. Link to any related issues with "Fixes #123" so GitHub tracks the relationship.
• Follow the code style. Match the existing code format in the repository.
• Test before requesting review. Make sure your changes actually work.

Milestones

Milestones group related issues and PRs toward a release or goal:

• Click the "Milestones" tab in your repository.
• Create a milestone (e.g., "v2.0", "Bug fix sprint").
• Assign issues and PRs to that milestone to track progress.

Frequently asked questions

Can I assign an issue to someone else?

Yes, use the "Assignees" field. You can assign issues to yourself or any collaborator with access to the repository.

How do I reopen a closed issue?

Click the "Reopen" button at the bottom of a closed issue. This is useful if a fix didn't fully resolve the problem.

Can I delete an issue or PR?

You cannot delete issues or PRs, but you can close them. If an issue was created by mistake, close it and leave a comment explaining why.

Need help?

If you have questions about using issues and PRs, contact support.