docs: Update PR template (#6235)
* Update PR template * Add screen capture section and simplify descriptions * Link out to PR title conventions & remove monitoring section
This commit is contained in:
parent
048607080c
commit
3c7eabc3d8
36
.github/pull_request_template.md
vendored
36
.github/pull_request_template.md
vendored
@ -1,24 +1,22 @@
|
|||||||
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
|
|
||||||
- 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:
|
- _Link to JIRA ticket, slack thread, or relevant docs helpful for providing context to reviewers._
|
||||||
|
|
||||||
- feat: adds support for gnosis safe wallet
|
- _Note: Your PR title must follow conventions [outlined here](https://github.com/Uniswap/interface#contributions)._
|
||||||
- fix: removes a polling memory leak
|
|
||||||
- chore: bumps redux version
|
|
||||||
|
|
||||||
Other things to note:
|
## Screen Capture
|
||||||
|
| Before | After |
|
||||||
|
| ---------------- |-----------------|
|
||||||
|
| _insert_before_ | _insert_after_ |
|
||||||
|
|
||||||
- Please describe the change using verb statements (ex: Removes X from Y)
|
|
||||||
- PRs with multiple changes should use a list of verb statements
|
## Test Plan
|
||||||
- Add any relevant unit / integration tests
|
#### Manual
|
||||||
- Changes will be previewable via vercel. Non-obvious changes should include instructions for how to reproduce them
|
|
||||||
|
_[Steps of how you are testing the change and ensuring no regression.]_
|
||||||
|
|
||||||
|
#### Automated
|
||||||
|
- [ ] Unit test
|
||||||
|
- [ ] Integration/E2E test
|
||||||
|
27
README.md
27
README.md
@ -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.
|
||||||
|
Loading…
Reference in New Issue
Block a user