Skip to content

PR Submission Guidelines

Keith G Strmiska edited this page Jul 7, 2022 · 1 revision

Pull Request Requirements for DesignSafe

Naming your Pull Request

When submitting a pull request, please include these 3 details in your title:

  • Is this change a fix for a Bug, feature Task, or Hotfix?
  • What is the Jira ID(s)?
  • Provide a brief descriptive Title for the changes

Examples:

  • Task/DES-1234 - Create notification banner for project submission
  • Bug/DES-1234 - Fix typo in notification banner
  • Hotfix/DES-1234 - Fix crashing interface caused by notification banner
  • Bug/DES-1234(1235)(1236) - Addressing multiple small issues in modal

Selecting your Reviewers

Select at least two reviewers for your pull request. If your pull request is large and will take considerable time to review, please reach out to the reviewers you assigned on Slack.

Fill out the Pull Request Template

Complete the provided template entirely!

## Overview: ##
[Describe the issue this PR will resolve or the feature being added]

## PR Status: ##

* [X] Ready.
* [ ] Work in Progress.
* [ ] Hold.

## Related Jira ticket(s): ##

* [DES-XXX](https://jira.tacc.utexas.edu/browse/DES-XXX)

## Summary of Changes: ##
[briefly summarize what you've changed to reach the desired result]

## Testing Steps: ##
1. [provide detailed steps that will allow the reviewer to validate your changes]

## UI Photos:
[provide screen shots of your UI changes to the portal (if any)]
[Before and After comparisons are good, and if there are numerous small changes, make sure to highlight them]

## Notes: ##
[any additional information that the reviewer should consider]