Skip to content

PULL_REQUEST_TEMPLATE.md

Latest commit

 

History

History
42 lines (30 loc) · 3.1 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

42 lines (30 loc) · 3.1 KB

Description of Changes

Please identify the particular changes that were made for this pull request.

Identify when the completion of this work took place

If your work was completed for a class project, please identify class and semester it was completed (ex., BA5200|Fall2025).

Identify which team you are on (ex., Team #|"team name")

If your work was completed for a class project, please indicate which team you completed the contribution for.

Identify GitHub issue associated with this work

Provide a link to the GitHub Issue here:

  • The GitHub Issue is ready to be closed after this pull request is approved and merged. Do not check this box if more work is left on the Issue.

Type of Change (check all that apply)

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Documentation addition/update (non-breaking change that adds documentation to the system)

Branch Management

  • I have updated my pull request so that it is up to date with the main branch.
  • Check this box if you would like to keep this branch for future use after the pull request is approved and merged. Leave unchecked if you want the branch deleted.

Coding Checklist

  • I have performed a self-review of my code. It runs without errors and follows the Best Coding Practices
  • My code follows the style guidelines outlined here
  • I have followed the git practices outlined here to ensure code conflicts are minimized.
  • There are no API keys, passwords, usernames, or other secrets in the code. I am using .env files for all secrets.
  • I provided documentation within my code for difficult logic and provided technical documentation in the documentation section to ensure my feature is easily maintainable.

Testing Checklist

  • I have added tests that prove my fix is effective or that my feature works.
  • I have followed the development note for testing software here

Documentation Checklist

  • There are no API keys, passwords or other secrets in the documentation
  • There is no personally identifiable information, such as real names, real email addresses, or real contact information in the documentation
  • If the documentation includes survey/interview questions, there are no responses to the question, only the questions themselves. For privacy, NO survey or interview responses should be added to the repository
  • I have checked the document conversion guide and double-checked that my file will be visible on GitHub’s platform