// Create pull requests for Canvas Android following project conventions. Use when user mentions creating PR, pull request, opening PR, or submitting changes for review. Includes PR template requirements and affects field guidelines.
| name | pr |
| description | Create pull requests for Canvas Android following project conventions. Use when user mentions creating PR, pull request, opening PR, or submitting changes for review. Includes PR template requirements and affects field guidelines. |
| allowed-tools | Bash, Read |
Create pull requests for Canvas Android following project conventions and using the standard template.
The PR template is located at /PULL_REQUEST_TEMPLATE in the repository root.
Use the GitHub CLI to create pull requests:
# Create PR (automatically uses template)
gh pr create
# Or with title and body
gh pr create --title "Your PR Title" --body "$(cat /path/to/description.md)"
The template will be automatically loaded when using gh pr create.
CRITICAL: The PR title MUST include the affected app(s) in square brackets AFTER the ticket ID.
Format: [TICKET-ID][AppName] Description
Examples:
[MBL-19497][Student] Fix bookmark URL placeholders from notifications[MBL-12345][Teacher] Add assignment grading improvements[MBL-67890][Student][Teacher] Fix discussion loading for both apps[MBL-11111][All] Update login flow across all appsRules:
affects: field in the PR bodyaffects: Student, use [Student]affects: Student, Teacher, use [Student][Teacher]affects: Student, Teacher, Parent, use [All]The PR template includes the following sections that must be completed:
Describe how to test the changes. Include:
SECURITY WARNING: NEVER include test credentials, passwords, API keys, or sensitive URLs in the test plan. The repository is public.
Use refs: followed by issue numbers:
refs: MBL-12345
or for multiple issues:
refs: MBL-12345, MBL-67890
IMPORTANT: Use affects: to specify which apps are impacted by the changes.
Valid values:
StudentTeacherParentExamples:
affects: Student
affects: Student, Teacher
affects: Student, Teacher, Parent
Provide a user-facing description of changes. This should be:
Complete the following items before marking PR as ready:
affects: field to specify which apps are impactedrefs:Title: [MBL-19453][Student] Add dashboard widget customization
Test plan:
1. Navigate to Dashboard
2. Verify widgets are displayed correctly
3. Test widget reordering
refs: MBL-19453
affects: Student
release note: Students can now customize their dashboard with widgets
Title: [MBL-12345][Student][Teacher] Improve discussion loading performance
Test plan:
1. Open any course
2. Verify discussion loading
3. Test comment threading
refs: MBL-12345
affects: Student, Teacher
release note: Improved discussion loading performance
Title: [MBL-67890][All] Update login flow
Test plan:
1. Launch any app
2. Log in with credentials
3. Verify successful authentication
refs: MBL-67890
affects: Student, Teacher, Parent
release note: Updated login experience for improved security
Build Canvas Android apps (Student, Teacher, Parent) using Gradle. Use when user mentions building, compiling, assembling, or making the app. Provides commands for dev, qa, and prod build variants.
Install and deploy Canvas Android apps to connected devices or emulators using adb and Gradle. Use when user mentions installing, deploying, running on device, launching app, or working with emulators.
Run unit tests and instrumentation tests for Canvas Android apps. Use when user mentions testing, running tests, JUnit, Espresso, or checking test results. Includes commands for Student, Teacher, and Parent apps.