Update readme and guidelines (#207)

* Update readme and guidelines * small edits * Update README.md (#208) * Update CONTRIBUTING.md * Update README.md remove duplicated contributing section --------- Co-authored-by: Sara Reynolds <[email protected]> Co-authored-by: marktoda <[email protected]>
Uniswap · Jun 12, 2023 · ba9073f · ba9073f
1 parent 125ee5a
commit ba9073f
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 17 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,28 +1,28 @@
 # Contribution Guidelines 
 
-Thanks for your interest in contributing to v4 of the Uniswap Protocol! The contracts in this repo are in early stages. There is a lot more development left before v4 is in a stable and production-ready state, and so we appreciate any kind of contribution, no matter how small.
+Thanks for your interest in contributing to v4 of the Uniswap Protocol! The contracts in this repo are in early stages - we are releasing the draft code now so that v4 can be built in public, with open feedback and meaningful community contribution. We expect this will be a months-long process, and we appreciate any kind of contribution, no matter how small.
 
 If you need to get in contact with the repository maintainers, please reach out in our [Discord](https://discord.com/invite/FCfyBSbCU5) .
 
 ## Types of Contributing
 
 There are many ways to contribute, but here are a few if you want a place to start:
 
-1. **Opening an issue.** Before opening an issue please check that there is not an issue already open. If there is, feel free to comment more details, explanations, or examples within the open issue rather than duplicating it. Suggesting changes to the open development process are within the bounds of opening issues. We are always open to feedback and receptive to suggestions!
+1. **Opening an issue.** Before opening an issue, please check that there is not an issue already open. If there is, feel free to comment more details, explanations, or examples within the open issue rather than duplicating it. Suggesting changes to the open development process are within the bounds of opening issues. We are always open to feedback and receptive to suggestions!
 2. **Resolving an issue.** You can resolve an issue either by showing that it is not an issue or by fixing the issue with code changes, additional tests, etc. Any pull request fixing an issue should reference that issue.
-3. **Reviewing open PRs.** You can provide comments, standards guidance, naming suggesetions, gas optimizations, or ideas for alternative designs on any open pull request. 
+3. **Reviewing open PRs.** You can provide comments, standards guidance, naming suggestions, gas optimizations, or ideas for alternative designs on any open pull request.
 
 ## Opening an Issue
 
-When opening an [issue](https://github.com/Uniswap/core-next/issues/new/choose), choose a template to start from, either a Bug Report or a Feature Improvement. For bug reports, you should be able to reproduce the bug through tests or proof of concept integrations. For feature improvements, please title it with a concise problem statement and check that a similar request is not already open or already in progress. Not all issues may be deemed worth resolving, so please follow through with responding to any questions or comments that others may have regarding the issue.
+When opening an [issue](https://github.com/Uniswap/v4-core/issues/new/choose), choose a template to start from: Bug Report or Feature Improvement. For bug reports, you should be able to reproduce the bug through tests or proof of concept integrations. For feature improvements, please title it with a concise problem statement and check that a similar request is not already open or already in progress. Not all issues may be deemed worth resolving, so please follow through with responding to any questions or comments that others may have regarding the issue.
 
 Feel free to tag the issue as a “good first issue” for any clean-up related issues, or small scoped changes to help encourage pull requests from first time contributors!
 
 ## Opening a Pull Request
 
 All pull requests should be opened against the `main` branch.  In the pull request, please reference the issue you are fixing.
 
-Pull requests can be reviewed by community members, but to be merged they will need approval from 2 of the repository maintainers. Please allow up to a week to receive a response, although the maintainers will aim to respond and comment as soon as possible.
+Pull requests can be reviewed by community members, but to be merged they will need approval from the repository maintainers. Please understand it will take time to receive a response, although the maintainers will aim to respond and comment as soon as possible.
 
 **For larger, more substantial changes to the code, it is best to open an issue and start a discussion with the maintainers to align on the change before spending time on the development.**
 
@@ -43,9 +43,9 @@ All contributions must follow the below standards. Maintainers will close out PR
 4. Picking up stale issues by other authors is fine! Please just communicate with them ahead of time and it is best practice to include co-authors in any commits.
 5. Squash commits where possible to make reviews clean and efficient. PRs that are merged to main will be squashed into 1 commit.
 
-## Tests 
+## Tests
 
-This repo currently uses hardhat and forge tests.* Please run both test suites before opening a PR. 
+This repo currently uses hardhat and forge tests.* Please run both test suites before opening a PR.
 
 `yarn snapshots` to update the hardhat gas snapshots
 
@@ -59,10 +59,8 @@ This repo currently uses hardhat and forge tests.* Please run both test suites b
 
 Any new tests that you add should be written with forge, as the repo is undergoing a full migration to the forge test suite.
 
-*Mythx was also used but is no longer run and in the process of being deprecated fully from the repo.
+## Code of Conduct
 
-## Code of Conduct 
+Above all else, please be respectful of the people behind the code. Any kind of aggressive or disrespectful comments, issues, and language will be removed.
 
-Above all else, please be respectful of the people behind the code. Any kind of aggressive or disrespectful comments, issues, and language will be removed. 
-
-Issues and PRs that are obviously spam and unhelpful to the development process or unrelated  to the core code will also be closed.
+Issues and PRs that are obviously spam and unhelpful to the development process or unrelated to the core code will also be closed.
diff --git a/README.md b/README.md
@@ -3,7 +3,11 @@
 [![Lint](https://github.com/Uniswap/v4-core/actions/workflows/lint.yml/badge.svg)](https://github.com/Uniswap/v4-core/actions/workflows/lint.yml)
 [![Tests](https://github.com/Uniswap/v4-core/actions/workflows/tests.yml/badge.svg)](https://github.com/Uniswap/v4-core/actions/workflows/tests.yml)
 
-Uniswap v4 is a new automated market market protocol that provides extensibility and customizability to pools. `v4-core` hosts the core pool logic for creating pools and executing pool actions like swapping and providing liquidity.
+Uniswap v4 is a new automated market maker protocol that provides extensible and customizable pools. `v4-core` hosts the core pool logic for creating pools and executing pool actions like swapping and providing liquidity.
+
+## Contributing
+
+If you’re interested in contributing please see our [contribution guidelines](https://github.com/Uniswap/v4-core/blob/main/CONTRIBUTING.md)!
 
 ## Architecture
 
@@ -84,10 +88,6 @@ contract MyContract is ILockCallback {
 
 ```
 
-## Contributing
-
-If you’re interested in contributing please see the [contribution guidelines](https://github.com/Uniswap/v4-core/blob/main/CONTRIBUTING.md)!
-
 ## License
 
 The primary license for Uniswap V4 Core is the Business Source License 1.1 (`BUSL-1.1`), see [LICENSE](https://github.com/Uniswap/v4-core/blob/main/LICENSE). Minus the following exceptions: