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 code docs #34

Closed
gakonst opened this issue Jun 18, 2018 · 10 comments
Closed

Improve code docs #34

gakonst opened this issue Jun 18, 2018 · 10 comments
Labels
good first issue Good for newcomers

Comments

@gakonst
Copy link
Contributor

gakonst commented Jun 18, 2018

  • Update contracts to have correct natspec docs
  • Ensure python client has correct documentation everywhere
  • Ensure js tests have correct documentation everywhere
  • Ensure setting up and getting a working local environment is well documented
@gakonst gakonst added the good first issue Good for newcomers label Jun 20, 2018
@gitcoinbot
Copy link

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


This issue now has a funding of 250.0 DAI (250.0 USD @ $1.0/DAI) attached to it.

@gitcoinbot
Copy link

@usmanmuhd Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

  • warning (3 days)
  • escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

@gitcoinbot
Copy link

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


Work has been started.

These users each claimed they can complete the work by 11 months from now.
Please review their action plans below:

  1. jcastle13 has started work.

    I would like to see if this project is still available. If so, I would like to contribute.

Learn more on the Gitcoin Issue Details page.

@vs77bb
Copy link

vs77bb commented Sep 12, 2018

@jcastle13 still looks available, yes 👍

@gitcoinbot
Copy link

gitcoinbot commented Sep 15, 2018

@jcastle13 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

  • warning (3 days)
  • escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

@jcastle13
Copy link

Is there any specific branch I should do a PR? Should doing a PR on master branch be ok to work on?

@spm32
Copy link

spm32 commented Sep 18, 2018

@gakonst any thoughts on the above?

@jcastle13
Copy link

I've been swamped with other projects that I will have to drop out on this project. Sorry about that.

@gakonst
Copy link
Contributor Author

gakonst commented Sep 25, 2018

Apologies for this delay! I should've closed this issue a while ago, given that our contracts are currently well documented, and the python client was an MVP - now we use the loom dappchain backend. @gitcoinbot could we close this bounty? We'll be bringing in new features soon which will be good candidates for bounties.

@gakonst gakonst closed this as completed Sep 25, 2018
@gitcoinbot
Copy link

Issue Status: 1. Open 2. Cancelled


The funding of 250.0 DAI (250.0 USD @ $1.0/DAI) attached to this issue has been cancelled by the bounty submitter

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

5 participants