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

Prepare to open repo to public #88

Merged
merged 15 commits into from
Jul 10, 2024
Merged

Prepare to open repo to public #88

merged 15 commits into from
Jul 10, 2024

Conversation

Art3miX
Copy link
Collaborator

@Art3miX Art3miX commented Jul 4, 2024

No description provided.

stiiifff
stiiifff reviewed Jul 4, 2024
View reviewed changes
Copy link
Contributor

@stiiifff stiiifff left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be good to add:

  • a project title and brief description
  • the Security section as on the Covenants repo.
  • a License section.
    • Side question: should we change the license currently being used to something more standard (e.g. Apache 2.0).

@Art3miX Art3miX changed the title clean readme a little Prepare to open repo to public Jul 9, 2024
@Art3miX Art3miX marked this pull request as draft July 9, 2024 12:41
This was linked to issues Jul 9, 2024
Create architecture.md #92
Closed
Add documentation on how service fees are handled #90
Closed
@Art3miX Art3miX marked this pull request as ready for review July 9, 2024 14:19
@Art3miX Art3miX requested a review from stiiifff July 9, 2024 14:19
@stiiifff
Copy link
Contributor

stiiifff commented Jul 9, 2024

Need to document how to bid on the auctions (add some explanations to the README).

uditvira
uditvira reviewed Jul 9, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
uditvira
uditvira reviewed Jul 9, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
uditvira
uditvira reviewed Jul 9, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
uditvira
uditvira reviewed Jul 9, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
uditvira
uditvira reviewed Jul 9, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
uditvira
uditvira reviewed Jul 9, 2024
View reviewed changes
README.md Show resolved Hide resolved
uditvira
uditvira reviewed Jul 9, 2024
View reviewed changes
README.md Show resolved Hide resolved
uditvira
uditvira reviewed Jul 9, 2024
View reviewed changes
README.md Show resolved Hide resolved
@Art3miX Art3miX mentioned this pull request Jul 10, 2024
Closed
1 task
@stiiifff
Copy link
Contributor

stiiifff commented Jul 10, 2024 •
edited
Loading

@Art3miX I don't see the explanations about how to bid on the auctions. Maybe we can add something like this on main README below the high-level system diagram:

Parties (e.g. market makers) interested to participate in the Rebalancer Auctions should read the Auctions contract documentation. (with link to Auctions contract README).

@Art3miX Art3miX merged commit 7b564e6 into main Jul 10, 2024
2 checks passed
@Art3miX Art3miX deleted the readme branch July 10, 2024 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@uditvira uditvira uditvira left review comments

@stiiifff stiiifff stiiifff approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create architecture.md Add documentation on how service fees are handled
3 participants
@Art3miX @stiiifff @uditvira