PULL_REQUEST_TEMPLATE.md

Resolves #{github issue number}

Description

Please explain the changes you made here.

Acceptance Criteria

• Code compiles correctly

Testing Plan

1. Go to ...

• For higher-risk changes: Deploy the custom branch to UAT to test

User Facing Changes

• Screenshots of UI changes added to PR & Original Issue

BEFORE	AFTER

Code Documentation Updates

• Add or update code comments at the top of the class, module, and/or component.

Storybook Story

For Frontend (Presentationa) Components

• Add a Storybook file alongside the component file (e.g. create MyComponent.stories.js alongside MyComponent.jsx)
• Give it a title that reflects the component's location within the overall Caseflow hierarchy
• Write a separate story (within the same file) for each discrete variation of the component

Database Changes

Only for Schema Changes

• Timestamps (created_at, updated_at) for new tables
• Column comments updated
• Have your migration classes inherit from Caseflow::Migration, especially when adding indexes (use add_safe_index)
• Verify that migrate:rollback works as desired (change supported functions)
• Query profiling performed (eyeball Rails log, check bullet and fasterer output)
• Appropriate indexes added (especially for foreign keys, polymorphic columns, unique constraints, and Rails scopes)
• DB schema docs updated with make docs (after running make migrate)
• #appeals-schema notified with summary and link to this PR
• Any non-obvious semantics or logic useful for interpreting database data is documented at Caseflow Data Model and Dictionary

Integrations: Adding endpoints for external APIs

• Check that Caseflow's external API code for the endpoint matches the code in the relevant integration repo
  • Request: Service name, method name, input field names
  • Response: Check expected data structure
• Update Fakes
• Integrations impacting functionality are tested in Caseflow UAT