-
Notifications
You must be signed in to change notification settings - Fork 16
PR Submission and Review
This page defines the requirements for each pull request. Before submitting any PR, please ensure you have done the following:
- Run the Test and Linting pipelines provided in the README.md
- Format the branch name correctly with the github issue number
- Complete the PR submission template
- Tag reviewers
The branch name should include the repo prefix followed by the github issue number.
TUI-1234
If a larger issue requires a series of issues to be completed, push a feature branch to which child issues can be merged.
TUI-1234--feature-name
Any child issues which relate to this feature branch should be formatted as usual.
When submitting a PR, unit tests, linting and formatting will be checked via pipelines. Prior to submission, please make sure that you:
- Include unit tests for new code
- Run
npm test - Run
npm run lint - Run
npm run prettier
## Overview: ##
## Related Github Issues: ##
* [TUI-1234](https://github.com/tapis-project/tapis-ui/issues/1234)
## Summary of Changes: ##
## Testing Steps: ##
1.
## UI Photos:
## Notes: ##
When submitting a PR you will be provided with a basic template to complete (shown above).
- Title your PR with the branch name followed by the name of the github issue separated with a hyphen
TUI-1234 - Add warning message to login page - Provide a detailed summary of what was changed, and provide clear testing instructions so that a reviewer can easily test the changes.
- Complete the link provided to the appropriate github issue.
- If you are pushing any changes which will alter the UI, submit images which will show the changes highlighted or in a before-and-after screen shot.
Make sure to tag at least one person for review when submitting your PR this can be the creator of the issue or someone else working on the repo. Feel free to ping the reviewer on slack as well.