Create Pull Requests for Canvas Android

Create pull requests for Canvas Android following project conventions and using the standard template.

PR Template Location

The PR template is located at /PULL_REQUEST_TEMPLATE in the repository root.

Creating a PR

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.

Template Requirements

The PR template includes the following sections that must be completed:

1. Test Plan Description

Describe how to test the changes. Include:

• Steps to reproduce/verify the fix or feature
• Expected behavior
• Any prerequisites or setup needed

2. Issue References

Use refs: followed by issue numbers:

refs: MBL-12345

or for multiple issues:

refs: MBL-12345, MBL-67890

3. Impact Scope (affects field)

IMPORTANT: Use affects: to specify which apps are impacted by the changes.

Valid values:

• Student
• Teacher
• Parent

Examples:

affects: Student

affects: Student, Teacher

affects: Student, Teacher, Parent

4. Release Note

Provide a user-facing description of changes. This should be:

• Written for end users, not developers
• Clear and concise
• Focused on user impact

5. Checklist

Complete the following items before marking PR as ready:

• Dark/light mode testing
• Landscape/tablet testing
• Accessibility testing
• Product approval (if needed)

Important Notes

• DO NOT include E2E tests or screenshots sections unless specifically needed
• Always include the affects: field to specify which apps are impacted
• Reference the related issue(s) with refs:
• Complete the checklist before marking the PR as ready for review

Examples

Example PR for Student App Only

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

Example PR for Multiple Apps

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