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.

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

Improve codebase documentation #18

Closed
0xibs opened this issue Nov 27, 2024 · 5 comments · Fixed by #27
Closed

Improve codebase documentation #18

0xibs opened this issue Nov 27, 2024 · 5 comments · Fixed by #27
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers ODHack10 This issue is part of OD HACK

Comments

@0xibs
Copy link
Collaborator

0xibs commented Nov 27, 2024

  • Currently the contract functions and interfaces are have little to no documentation. The task here is to add proper documentation that describes what the contract functions does, expected input/output, etc
  • The README contains less information about the AutoSwappr contracts and how to contribute. The task here is to add more information to the README such that new contributors can know more about the project and find their way around the codebase. The README should contain info such as description of the project, how to set up the project locally, how to contribute, etc.
@0xibs 0xibs added documentation Improvements or additions to documentation good first issue Good for newcomers ODHack10 This issue is part of OD HACK labels Nov 27, 2024
@Luluameh
Copy link

Can I try solving this issue?
This would be nice to have as my first contribution to the spotnet draft in less than 8 hours.
@lulu_greg telegram handle

@Kingsuite
Copy link
Contributor

Can I tackle this one?

@jahrulezfrancis
Copy link

May I be assigned to this? I'll be excited to to work on it.

@Luluameh
Copy link

Can I be assigned to this?
This would be nice to have as my first contribution to the auto-swap draft in less than 8 hours.

@Agbeleshe
Copy link

Hello, I would love to make this my first contribution. Thank you. will make a pr in less than two hours I have time to spare. thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers ODHack10 This issue is part of OD HACK
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants