Improve code docs - Githubissues

loomnetwork / plasma-cash

Plasma Cash Contract & Client. ERC721, ERC20, and ETH compatible

https://loomx.io/developers

Other

271 stars 62 forks source link

Improve code docs #34

Closed gakonst closed 6 years ago

gakonst commented 6 years ago

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

gitcoinbot commented 6 years ago

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.

If you would like to work on this issue you can 'start work' on the Gitcoin Issue Details page.
- Want to chip in? Add your own contribution here.
- Questions? Checkout Gitcoin Help or the Gitcoin Slack
- $23,595.11 more funded OSS Work available on the Gitcoin Issue Explorer

gitcoinbot commented 6 years ago

@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!

[x] warning (3 days)
[ ] escalation to mods (6 days)

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

gitcoinbot commented 6 years ago

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:

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 commented 6 years ago

@jcastle13 still looks available, yes 👍

gitcoinbot commented 6 years ago

@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!

[x] warning (3 days)
[ ] escalation to mods (6 days)

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

jcastle13 commented 6 years ago

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

spm32 commented 6 years ago

@gakonst any thoughts on the above?

jcastle13 commented 6 years ago

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

gakonst commented 6 years ago

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.

gitcoinbot commented 6 years ago

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

Questions? Checkout Gitcoin Help or the Gitcoin Slack
$21,203.36 more funded OSS Work available on the Gitcoin Issue Explorer