Commit 3c7eabc3 authored by yyip-dev's avatar yyip-dev Committed by GitHub

docs: Update PR template (#6235)

* Update PR template

* Add screen capture section and simplify descriptions

* Link out to PR title conventions & remove monitoring section
parent 04860708
Your PR title must follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary), and should start with one of the following [types](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type): ## Description
- build: Changes that affect the build system or external dependencies (example scopes: yarn, eslint, typescript) _[Summary of change, motivation, and context.]_
- ci: Changes to our CI configuration files and scripts (example scopes: vercel, github, cypress)
- docs: Documentation only changes - _Link to JIRA ticket, slack thread, or relevant docs helpful for providing context to reviewers._
- feat: A new feature
- fix: A bug fix - _Note: Your PR title must follow conventions [outlined here](https://github.com/Uniswap/interface#contributions)._
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature ## Screen Capture
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | Before | After |
- test: Adding missing tests or correcting existing tests | ---------------- |-----------------|
| _insert_before_ | _insert_after_ |
Example commit messages:
- feat: adds support for gnosis safe wallet ## Test Plan
- fix: removes a polling memory leak #### Manual
- chore: bumps redux version
_[Steps of how you are testing the change and ensuring no regression.]_
Other things to note:
#### Automated
- Please describe the change using verb statements (ex: Removes X from Y) - [ ] Unit test
- PRs with multiple changes should use a list of verb statements - [ ] Integration/E2E test
- Add any relevant unit / integration tests
- Changes will be previewable via vercel. Non-obvious changes should include instructions for how to reproduce them
...@@ -38,6 +38,33 @@ You can block an entire list of tokens by passing in a tokenlist like [here](./s ...@@ -38,6 +38,33 @@ You can block an entire list of tokens by passing in a tokenlist like [here](./s
For steps on local deployment, development, and code contribution, please see [CONTRIBUTING](./CONTRIBUTING.md). For steps on local deployment, development, and code contribution, please see [CONTRIBUTING](./CONTRIBUTING.md).
#### PR Title
Your PR title must follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary), and should start with one of the following [types](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type):
- build: Changes that affect the build system or external dependencies (example scopes: yarn, eslint, typescript)
- ci: Changes to our CI configuration files and scripts (example scopes: vercel, github, cypress)
- docs: Documentation only changes
- feat: A new feature
- fix: A bug fix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- test: Adding missing tests or correcting existing tests
Example commit messages:
- feat: adds support for gnosis safe wallet
- fix: removes a polling memory leak
- chore: bumps redux version
Other things to note:
- Please describe the change using verb statements (ex: Removes X from Y)
- PRs with multiple changes should use a list of verb statements
- Add any relevant unit / integration tests
- Changes will be previewable via vercel. Non-obvious changes should include instructions for how to reproduce them
## Accessing Uniswap V2 ## Accessing Uniswap V2
The Uniswap Interface supports swapping, adding liquidity, removing liquidity and migrating liquidity for Uniswap protocol V2. The Uniswap Interface supports swapping, adding liquidity, removing liquidity and migrating liquidity for Uniswap protocol V2.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment