Web: Notify Gitcoin/Funder that Developer is Starting Work

[PixelantDesign]

User Story

As a developer/contributor, I want to notifiy Gitcoin that I'm starting work in one place.

Description

Type: Feature

Summary: Currently users make a comment on the Github issue that they'd like to start work, but sometimes forget to go to Gitcoin to click the start work button. Sometimes users also are not aware that they should ask questions about the ticket or provide an approach to the funder.

Expected Behavior

User should notify Gitcoin in just one place by clicking start work button. A short form opens asking the user a few questions and when user clicks submit, the notes automatically get posted to Github and we accept this as the user has started work.

Solution

Summary: Please see attached wireframes and designs.

Definition of Done

• All button states are implemented.
• Form and confirmation is implemented.
• GitcoinBot comment is updated to include the commentary that the developer provided directly in the
  Gitcoin form, should appear on the Github thread (see wireframe).

Additional Information

Please work with @thelostone-mc who is building #419 (Issue details page)
Please review with @PixelantDesign

Materials

Gitcoin - Start Issue.pdf

[gitcoinbot]

__This issue now has a funding of 0.17 ETH (97.5 USD @ $573.53/ETH) attached to it.__

• If you would like to work on this issue you can claim it here.
• If you've completed this issue and want to claim the bounty you can do so here
• Questions? Get help on the Gitcoin Slack
• $3650.83 more Funded OSS Work Available at: https://gitcoin.co/explorer

[elmarti]

EDIT: COMMENT WAS REMOVED WHEN I REASSIGNED MYSELF :)
Hi, regarding the above comment, I found Gitcoin through this job post https://angel.co/gitcoin/jobs/325636-front-end-developer and I was examining the platform as a first time user. This was triggered accidentally as it wasn't immediately clear to me what the implications of clicking it were, which I guess is the root issue here!

[elmarti]

Hi, further to my above comment, I thought i'd give the platform a spin!

Assumptions

• Accessibility has not been a big focus
• jQuery/jQuery modal are included and usable
• Front end project doesn't (yet) leverage a package manager

Solution

• jQuery modal is being used here in a lazy loading style https://github.com/gitcoinco/web/blob/7640a87bb3b4cf5475aa2196c5ffea6cedfd6afe/app/assets/v2/js/base.js#L29
• This pattern can be reused to create the new modal form as a new template
• Expand this endpoint so that gitcoinbot can post the message into the issue https://github.com/gitcoinco/web/blob/bad79358550661fff14270371675441d6160d4ef/app/dashboard/views.py#L87

Questions

• I believe that the user should see a confirm dialog when clicking "Stop work", what do you think? In its currently state it's easy to throttle.
• Is there a deadline for this, or is it to be done within the expiration period shown on the Gitcoin site?

Other general refactoring

• In the JavaScript I've looked at so far I have noticed a few things such non-typesafe checks ie value == null vs value === null. I can fix them if it's wanted.

[owocki]

I believe that the user should see a confirm dialog when clicking "Stop work", what do you think? In its currently state it's easy to throttle.

I believe we didn't include that in scope for a reason. @PixelantDesign what do you think?

Is there a deadline for this, or is it to be done within the expiration period shown on the Gitcoin site?

Just within the timeline on the bounty. Though we'd ask that if you decide not to work on this that you be mindful that you release it back to an 'open' state so that others can jump in!

edit: your solutions and other refactoring notes sound right to me

[PixelantDesign]

I believe that the user should see a confirm dialog when clicking "Stop work"

@elmarti good catch. The user should definitely see a confirmation if they come back and click stop work. Ideally, the gitcoin bot would also post that on the github thread.

Thanks!

[elmarti]

@PixelantDesign Thanks, so should that be done within the scope of this issue? If so, shall I await a mockup, design myself or use the native confirm dialog - I tend not to use them outside of Cordova development but they appear to be used in this application. Maybe a better issue would be to look at replacing them and use the confirm dialog here in the mean time?

[elmarti]

Another thing, I'm just having a look at the backend code, I can't quite seem to see where gitcoinbot gets messaged https://github.com/gitcoinco/web/blob/2717d0d5192f79901d90d7ab8e3c373d57b81dc1/app/dashboard/views.py#L127, can anyone clarify? I'm assuming at this point that there's some sort of database hook at play, but I may be totally wrong..

Another thing, I'm planning on extending the interest model, are there any implications of this or does anyone have any objections? I'm naturally opposed to this as it's duplicated data, but I can't see any other way at present

[mbeacom]

@elmarti You should be able to add the new fields to Interest.

[owocki]

github bot gets messaged in maybe_market_to_github()

[elmarti]

Hi, what is the expected behaviour of the radio buttons for "Do you have any questions"? are they there for showing/hiding the textarea below?

[elmarti]

https://github.com/elmarti/web Work started

[owocki]

Hi, what is the expected behaviour of the radio buttons for "Do you have any questions"? are they there for showing/hiding the textarea below?

Good question: @PixelantDesign -- what do you think is the best practice here?

[PixelantDesign]

@elmarti

Hi, what is the expected behaviour of the radio buttons for "Do you have any questions"? are they there for showing/hiding the textarea below?

The radio button is not meant to be progressive. A user could not have any questions but also have a concern/info/ or approach they want to share with the funder/project owner.

[elmarti]

Currently having some issues testing as I currently don't have any ETH, is there any way to bypass this for testing, or to fudge in some example bounties?

[owocki]

yes you can import some bounties using the instructions here https://github.com/gitcoinco/web/blob/master/docs/RUNNING_LOCALLY_DOCKER.md#optional-import-bounty-data-from-web3-to-your-database

i also recommend getting some rinkeby eth and testing via rinkeby, which you can do here => https://faucet.rinkeby.io/

[elmarti]

Moving onto the styling now, just got one minor UX issue - there doesn't seem to be a clear way to asynchronously handle error responses when mutating the interest, it seems to rely on alerting the user via the alert dialog in mutate_interest. This makes it impossible to detect when the request has failed.

In its current form I managed to get the request to fail, but still have it the client side state so interest has been registered. It may be a general issue rather than something within the scope of this issue. This will mean, if the mutate interest request fails, there's no clean way of preventing the loss of the message written in the modal.

[elmarti]

I've noticed there are 2 different designs in the PDF and posted in the issue.. I've tried to find a middle ground in the mean time:

[elmarti]

Hi, pretty much done in terms of functionality, just hit an interesting snag in dashboard/notifications.py...

In build_github_notification it uses the profile_pairs object to build a list of users undertaking the project as it does here https://github.com/gitcoinco/web/issues/683#issuecomment-375489064.

It's a bit confusing that the "Start work" button triggers the creation of an Interested ManyToMany object, which is then used to bind a single developer to the task (AFAIK), and then looking at the PDF It looks like the new comment is also bound to a single user.

Is it that in build_github_notification method, we can safely rely on a maximum number of 1 developers being there for this particular event, or am I missing something? 🙃

[owocki]

I believe that the Interested object is many to manage for a reason. you should assume that there is between 0 and n interested parties for a Bounty.

[owocki]

So the problem you are trying to solve is to figure out which/how to present each users' comments in the github notification after creation of the Interested object?

[elmarti]

Yeah, in the PDF the text shows as follows:

Work Started.
@ has committed to working on this project to be completed in 2 weeks.
Please answer following questions/comments @owocki:
Please confirm resolution and browser support required.

I guess it could just be modified to have some kind of comma separated list, but it depends on whether there are future plans for internationalization as this would hard code the grammar logic.

[owocki]

i think a comma seperated list works for now. we will handle the intl8zn later

[elmarti]

Ok, should hopefully have a PR in for this tomorrow

[mbeacom]

@elmarti Anything I can do to help you with this? Whenever you raise the PR, I'll be sure to take a look!

[elmarti]

Hi @mbeacom, just in the final stages, having a bit of trouble attaching to the docker container for debugging before a PR, any advice? I think I will have to run it without which may be difficult

[thelostone-mc]

@elmarti what's the error you get when your run docker ?

[elmarti]

Hi @thelostone-mc there's no error when running the docker container, I can't seem to attach to the docker instance to breakpoint the code I've written in Cloud9 and I don't feel comfortable submitting a PR without doing that first

[thelostone-mc]

@mbeacom help needed !!
Don't think I'd be of much help here

[PixelantDesign]

@mbeacom, please assist! Thanks!

[elmarti]

Hi, I've received an email noting that I've been removed from the task, that's fine given I can't see how to proceed from this point, feel free to use the work I've completed so far, just a little bit of backend work to do - building the message for gitcoinbot

[owocki]

thanks for letting us know about your availability @elmarti

[owocki]

for anyone who's picked up the task since then, here are the docs about how to set a breakpoint inside docker

[owocki]

@thelostone-mc any interest in picking this up?

WIP PR https://github.com/gitcoinco/web/issues/683

[owocki]

I'd say most of the ppl jumping into these already have jobs and are working on the side. Although a deadline is put on the bounty, it's also nice to to have a general understanding of how much time they allot to these side projects. IE - if you have two ppl jumping on a task or a 2nd person that wants to take a task and they have way more bandwidth... that's good info to have.

good feedback from @villanuevawill -- perhaps this is a question we should be asking on the 'start work' modal?

[PixelantDesign]

hmmm...what if we asked the contributor to confirm whether they think they could complete the project by x date?

[villanuevawill]

@PixelantDesign my original intention behind this idea is it gives a good criteria to choose a candidate to work with. For example, I may be loose on my timeline, because I realize code may take longer and shorter than I originally scoped. However, I may be more likely to team up with someone who has more availability in their schedule and can finish the task more quickly.

[gitcoinbot]

Issue Status: 1. Open 2. Expired

---

__Work has been started__.
@darkdarkdragon has committed to working on this project to be completed 1 week, 2 days ago.

[gitcoinbot]

@darkdarkdragon are you still working on this issue?

[darkdarkdragon]

Yes, I'll make pr today.

[gitcoinbot]

⚡️ A tip worth 0.17 ETH (116.6 USD @ $685.87/ETH) has been granted to @darkdarkdragon for this issue from Kevin. ⚡️

The sender had the following public comments:

Thanks.. This is great!

Nice work @darkdarkdragon! To redeem your tip, login to Gitcoin at https://gitcoin.co/explorer and select 'Claim Tip' from dropdown menu in the top right, or check your email for a link to the tip redemption page.

• $6979.94 in Funded OSS Work Available at: https://gitcoin.co/explorer
• Incentivize contributions to your repo: Send a Tip or Fund a PR
• No Email? Get help on the Gitcoin Slack

[gitcoinbot]

Issue Status: 1. Open 2. Expired

---

__The funding of 0.17 ETH (115.72 USD @ $680.72/ETH) attached to this issue has been cancelled by the bounty submitter__

• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $6,947.64 more funded OSS Work available on the Gitcoin Issue Explorer

[gitcoinbot]

⚡️ A tip worth 0.17 ETH (115.72 USD @ $680.72/ETH) has been granted to @darkdarkdragon for this issue from Kevin. ⚡️

The sender had the following public comments:

wooooo hoooooooooooo

Nice work @darkdarkdragon! To redeem your tip, login to Gitcoin at https://gitcoin.co/explorer and select 'Claim Tip' from dropdown menu in the top right, or check your email for a link to the tip redemption page.

• $8140.08 in Funded OSS Work Available at: https://gitcoin.co/explorer
• Incentivize contributions to your repo: Send a Tip or Fund a PR
• No Email? Get help on the Gitcoin Slack

[thelostone-mc]

Thanks for this @darkdarkdragon ^_^
Looking forward to working with you again