Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: move TL;DR to the top of the readme #137

Closed
0xneves opened this issue Dec 8, 2023 · 5 comments · Fixed by #148
Closed

docs: move TL;DR to the top of the readme #137

0xneves opened this issue Dec 8, 2023 · 5 comments · Fixed by #148
Assignees
@0xjoaovpsantos
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone
Swaplace v1.0.0

Comments

@0xneves
Copy link
Contributor

0xneves commented Dec 8, 2023

Proposal:

  • Change the TLDR: into TL;DR
  • Add more features, like create swap, accept swap
  • Describe the other fields, use example from the Uniswap Permit2
@0xneves 0xneves added the documentation Improvements or additions to documentation label Dec 8, 2023
@0xneves 0xneves added this to the Swaplace v1.0.0 milestone Dec 8, 2023
@0xneves 0xneves added this to Swaplace Dec 8, 2023
@0xneves 0xneves moved this to 🔖 TODO in Swaplace Dec 8, 2023
@0xjoaovpsantos
Copy link
Contributor

Can I get this issue? @0xneves

@0xneves
Copy link
Contributor Author

0xneves commented Dec 14, 2023

Let's go! Send us da pull request!

@0xneves 0xneves moved this from 🔖 TODO to 🛠️ In Progress in Swaplace Dec 14, 2023
@0xjoaovpsantos
Copy link
Contributor

#148

@0xneves 0xneves moved this from 🛠️ In Progress to 🕵️‍♀️ In Review in Swaplace Dec 19, 2023
@0xneves
Copy link
Contributor Author

0xneves commented Dec 19, 2023

#148
Hey @0xjoaovpsantos will give you a hint on github:

You can write the following in your PR:
closes #<issue>

it will automatically close the issue when approved and also link the PR with the issue.

The way you are doing by referring to the PR in the issue won't suit the linking between them.

@0xneves 0xneves mentioned this issue Dec 19, 2023
Merged
3 tasks
@0xneves
Copy link
Contributor Author

0xneves commented Dec 19, 2023

closed by #148

@0xneves 0xneves closed this as completed Dec 19, 2023
@0xneves 0xneves moved this from 🕵️‍♀️ In Review to ✅ Done in Swaplace Dec 19, 2023
@0xneves 0xneves added the good first issue Good for newcomers label Jan 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@0xjoaovpsantos 0xjoaovpsantos

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
Swaplace
Status: ✅ Done
Milestone
Swaplace v1.0.0
Development

Successfully merging a pull request may close this issue.

doc: [ISSUE-137] Update readme 0xjoaovpsantos/swaplace-contracts
2 participants
@0xjoaovpsantos @0xneves