From b6f9fc33dc842cc9c9f9294b29aad081c4785232 Mon Sep 17 00:00:00 2001 From: Alice <34962750+hensha256@users.noreply.github.com> Date: Tue, 13 Jun 2023 13:30:02 +0200 Subject: [PATCH] README: whitepaper and small changes (#218) * Whitepaper in readme * Update README.md --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 2 +- README.md | 10 +++++++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index 456181310..17c5b5e9a 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -20,7 +20,7 @@ body: description: Provide a clear and concise description of the desired fix. validations: required: true - - type: input + - type: textarea attributes: label: To Reproduce description: If you have written tests to showcase the bug, what can we run to reproduce the issue? diff --git a/README.md b/README.md index daa7a2a61..39421be75 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,15 @@ 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. +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. + ## Contributing -If you’re interested in contributing please see our [contribution guidelines](https://github.com/Uniswap/v4-core/blob/main/CONTRIBUTING.md)! +If you’re interested in contributing please see our [contribution guidelines](./CONTRIBUTING.md)! + +## Whitepaper + +A more detailed description of Uniswap v4 Core can be found in the draft of the [Uniswap v4 Core Whitepaper](./whitepaper-v4-draft.pdf). ## Architecture @@ -33,8 +39,6 @@ Hooks may also elect to specify fees on swaps, or liquidity withdrawal. Much lik The fee values, or callback logic, may be updated by the hooks dependent on their implementation. However _which_ callbacks are executed on a pool, including the type of fee or lack of fee, cannot change after pool initialization. -Read a more in-depth overview of the design decisions in the working v4-whitepaper. - ## Repository Structure All contracts are held within the `v4-core/contracts` folder.