Grant categories for new grants #5615

vince0656 · 2019-12-08T11:04:21Z

Description

Work to enable grant categories to be defined on creation of a grant. A user can specify multiple categories for a grant which then appear on the grant's card on the grant explorer and can be edited later on the details page. Users can now also select categories on the grant explorer and view all grants that relate to that category.

Refers/Fixes

#5456

Testing

Appropriate unit tests have been added

Video Demonstration

I have separated this in two parts. Firstly, creation and updating of both types of grants as follows:
https://drive.google.com/open?id=1YeoU0InrJAnDGLYciKBoC8egZ1NA_o7a

and then category filtering on the grant explorer as follows:
https://drive.google.com/open?id=1FHwHSiSgt4AxF4y-YUrYmH_1pKEQCHkt

It's taken a while to get to the point where all of these features are robust and stable so I'm very happy with where the code is at this point

codecov · 2019-12-11T07:43:40Z

Codecov Report

Merging #5615 into master will decrease coverage by 0.51%.
The diff coverage is 25.91%.

@@            Coverage Diff            @@
##           master   #5615      +/-   ##
=========================================
- Coverage   29.51%     29%   -0.52%     
=========================================
  Files         265     271       +6     
  Lines       22912   23713     +801     
  Branches     3331    3450     +119     
=========================================
+ Hits         6763    6877     +114     
- Misses      15871   16562     +691     
+ Partials      278     274       -4

Impacted Files	Coverage Δ
app/app/settings.py	`80.06% <ø> (ø)`	⬆️
app/bounty_requests/admin.py	`100% <ø> (ø)`	⬆️
app/quests/admin.py	`46.55% <0%> (-0.82%)`	⬇️
app/kudos/models.py	`51.71% <0%> (-0.72%)`	⬇️
app/kudos/admin.py	`60.24% <0%> (-0.74%)`	⬇️
...eting/management/commands/assemble_leaderboards.py	`42.2% <0%> (-21.04%)`	⬇️
app/quests/models.py	`41.89% <0%> (-0.96%)`	⬇️
...board/management/commands/create_search_results.py	`0% <0%> (ø)`
app/retail/emails.py	`22.45% <0%> (-0.82%)`	⬇️
app/grants/utils.py	`19.04% <0%> (-0.96%)`	⬇️
... and 46 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update aa30da8...4f24515. Read the comment docs.

sirlupinwatson

LGTM

sirlupinwatson · 2019-12-12T21:49:24Z

Great Job ALL

owocki

needs testing.. and also to be DRY'd up

app/assets/v2/js/grants/detail.js

app/assets/v2/js/grants/new.js

app/grants/models.py

thelostone-mc · 2019-12-14T08:04:30Z

@vince0656
In live right now when you click on the nav item -> it updates the URL's keyword param and we just do a search for keyword
This is same as the search bar

Could you ensure that search bar works as expected and categories does not
mess up the search works as of now

vince0656 · 2019-12-14T08:08:44Z

Ok. Hope to look into these requests at some point today. Thanks guys👍🏼

thelostone-mc

DRY code comments from @owocki need to be addressed
need a video recording of how it works + ensure design doesn't break on mobile/ tablet
how does the card look when there is no tag for a grant.
could you also double check if search (the comment i left above) works as expected

Just giving you an update that I've got #5637 coming in which might give migration conflicts => you would have to recreate the migration file if 5637 get's in earlier

thelostone-mc · 2019-12-15T09:50:57Z

Additionally checking out the code + syncing up with scott
@vince0656 Hear me out and tell me what you think

A grant could be associated with a multiple categories.
Take any Dapp -> It could be UI + Wallet + ETH2.0
This means the model would have to be updated ->
to be a comma-separated values

1. New Grant -> select multiple categories -> get stored as comma-separated values
Example: Grant 1 -> ['UI', 'UX', 'DeFi']
2. View Grant Card -> it will show all selected categories (as opposed to just one) aka UI, UX, DeFi
3. Search -> We'd have to a contains match to see if a grant is of a particular category
4. This would have to be made shown in the grant detail page + editable if you are a grant owner
( OUT OF SCOPE but this can come in part 2 which I can bounty it out for you if you're up for it )

thelostone-mc:speech_balloon:  1 day ago
@Scott Moore The bounty you had put up!
Are we sure that a grant can be part of only one category?
The way that PR is setup ->
Grant can be either Mobile / UI-UX / Eth2.0 but not all which I don't think is valid always.
Eg: Matic


Scott Moore  16 hours ago
Regarding the categories, a grant can definitely be part of multiple categories.

sirlupinwatson

:)

owocki · 2019-12-16T19:44:50Z

this feedback makes sense to me... but it is a slight change in scope.. happy to provision more ETH to this if it helps get it across the finish line

vince0656 · 2019-12-16T20:02:45Z

@owocki happy to do the change in scope if you chuck more eth. Cheers

owocki · 2019-12-16T20:54:24Z

sure - let me know how much you think is fair

…

On Mon, Dec 16, 2019 at 1:02 PM Vincent ***@***.***> wrote: @owocki <https://github.com/owocki> happy to do the change in scope if you chuck more eth. Cheers — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#5615?email_source=notifications&email_token=AAD5PCKAXNTIKTPVVFT3LILQY7NGVA5CNFSM4JX2JSC2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEG75ITQ#issuecomment-566219854>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAD5PCNBYREI767CGU3LO3LQY7NGVANCNFSM4JX2JSCQ> .

-- @owocki <http://www.twitter.com/owocki>

_________________________________________ gitcoin is live and has generated over $2.7mm for Open Source Software - see our results <https://gitcoin.co/results>

thelostone-mc · 2019-12-18T06:36:55Z

@vince0656 feel free to hit me up if you hit a roadblock cause I'd like to get this in by next week if possible
Totally open to breaking it into two chunks if that makes it easier

vince0656 · 2019-12-18T07:53:11Z

Hi @owocki and @thelostone-mc. Sorry about the delay in replying, I’ve had various house emergencies to attend to this week but I’ve pretty much sorted them now.

I’ve had a think and think that splitting into two to get it over the line is a good idea. HOwever, I think the first part needs to enable support for multiple categories now but only store 1 category. I.e the django backend has support for multiple but UI only allows selecting one as it currently does. That way, the model doesn’t need messing with second time round. Second time round I can make the UI changes to enable this.

What do you guys think?

Given ETH is going down etc is it fair to ask for another 0.6 ETH for the second bit which also covers some bits in the first part?

vince0656 · 2019-12-18T08:16:14Z

Category badge does work with a slight tweak - in part 2 it will look good with multiple categories :)

owocki · 2019-12-18T21:12:24Z

@vince0656 0.6 ETH is fine.. :make_it_so: ! can u have a PR thats ready for merge by next week? gitcoin grants round 4 is very soon so we have a sense of urgency here

vince0656 · 2019-12-19T08:10:05Z

@owocki I think that's fair - let's get it done 👍

vince0656 · 2019-12-19T08:22:00Z

Fingers crossed these build issues are sorted 🤞

vince0656 · 2019-12-19T08:22:56Z

Next need to make a Grant model support a list of categories rather than store a single one as it currently does

thelostone-mc · 2019-12-19T13:22:26Z

@vince0656 you can check out the bounty model keywords as a reference cause it's the same thing dashboard/models.py

owocki · 2019-12-19T22:54:11Z

@vince0656 sounds good! looking fwd

sirlupinwatson

Great Work @vince0656 . 🥇

sirlupinwatson

Nice Code @vince0656

thelostone-mc · 2019-12-26T17:01:31Z

@vince0656 you think we'd be able to get this in next week ?

vince0656 · 2019-12-29T17:56:58Z

@thelostone-mc apologies - working on it now

thelostone-mc · 2020-02-05T14:09:36Z

@vince0656 would you be able to get this to the finish line ?
It's a lil past it's due date and I don't want this PR to go stale !

vince0656 · 2020-02-06T21:40:39Z

@thelostone-mc apologies. I've not been very well but am going to jump back into this

…ry-tagging

vince0656 · 2020-02-07T08:21:37Z

Having to run make fresh # docker-compose down -v; docker-compose up -d --build; as having lots of issues running the app after a pull

vince0656 · 2020-02-08T17:28:49Z

ok so creation, update and category display are all working with the many to many field / architectural changes requested by @danlipert. I'm going to wrap this up and hopefully record a video to attach to this PR to show this in action

vince0656 · 2020-02-09T21:42:52Z

@thelostone-mc @octavioamu @danlipert @owocki we are ready to go 🚀

owocki · 2020-03-02T20:28:56Z

@vince0656
guys is this live now?

https://twitter.com/MesquitaDaniell/status/1234558877984808965

im seeing several things that dont make sense in prod

people can see the edit view for grants they dont own
people can't edit their own categories.. or cant' figure it out (for example: what on earth do i do with this? https://bits.owocki.com/L1ugJqQo )
people cant figure out how to add categories to their new grants when posting them ( https://bits.owocki.com/z8uXZK4X )

gitcoin grants round 5 is less than 2 weeks away. can we get a fix PR in for this?

danimesq · 2020-03-02T20:44:10Z

That's why my bio says "Since 2013 irritating developers on GitHub, with more than 1000 issues open". It gets good results for benefit of all of us.

I didn't quickly noticed it and only remembered now, but yes, it showed the "Edit" button when I'm not logged (phone). https://gitcoin.co/grants/455/floflis-os

I have a question: why a contract for a grant? I mean, it makes sense but, what and how it does?

vince0656 · 2020-03-02T20:50:27Z

@vince0656
guys is this live now?

https://twitter.com/MesquitaDaniell/status/1234558877984808965

im seeing several things that dont make sense in prod

people can see the edit view for grants they dont own

people can't edit their own categories.. or cant' figure it out (for example: what on earth do i do with this? https://bits.owocki.com/L1ugJqQo )

people cant figure out how to add categories to their new grants when posting them ( https://bits.owocki.com/z8uXZK4X )

gitcoin grants round 5 is less than 2 weeks away. can we get a fix PR in for this?

Hey @owocki !

Looks like the code has been deployed in production and there seems to be a disconnect between people's expectation of the feature and how it's been designed to work. I think people are expecting the field to allow them to add custom tags. However, there are only a restricted set of categories people can actually choose.

Regarding the grant mentioned in the tweet, looks like you may be able to create a grant without any categories which is probably not desired.

people seeing edit view for grants they don't own - not sure how this is possible and shouldn't be related to work I've done as I made changes to the edit form and not the functionality that triggers the form.

The categories available depend on the grant type of the grant being created. For example, the categories that one can select for tech grants can be queried by hitting:

https://gitcoin.co/grants/categories?type=tech

for media grants:

https://gitcoin.co/grants/categories?type=media

The free text search field for categories (when creating and editing a grant) operates like the team members one and therefore allows you to search for one of the above categories based on the grant type selected. If it's easier, it could be changed to a drop down.

Once the categories have been added, people can then search by category on the grant explorer page.

Video Demonstration
I have separated this in two parts. Firstly, creation and updating of both types of grants as follows:
https://drive.google.com/open?id=1YeoU0InrJAnDGLYciKBoC8egZ1NA_o7a

and then category filtering on the grant explorer as follows:
https://drive.google.com/open?id=1FHwHSiSgt4AxF4y-YUrYmH_1pKEQCHkt

Let me know how you want to proceed as I thought this was all approved and wrapped up

vince0656 · 2020-03-02T20:54:04Z

Actually, a pure drop down will not allow multiple category selection. However, there may be a way to preview all possible options to filter using select2js

vince0656 · 2020-03-02T20:55:12Z

@owocki looks like you can do it like this instead: https://select2.org/getting-started/basic-usage#multi-select-boxes-pillbox

This way, people know what they can select and can select multiple

owocki · 2020-03-02T23:58:15Z

yeah we have select2 on the site already.. id recommend using that instead of the autocomplete

also we should not make the categories look editable when ur not viewing ur own grant. thats confusing

vince0656 · 2020-03-06T18:29:49Z

@owocki let me take a look and open up a PR for these quick fixes. Thanks

owocki · 2020-03-23T19:26:54Z

@thelostone-mc this ok to payout?

vince0656 marked this pull request as ready for review December 12, 2019 20:16

vince0656 requested review from danlipert, octavioamu and thelostone-mc as code owners December 12, 2019 20:16

sirlupinwatson approved these changes Dec 12, 2019

View reviewed changes

owocki requested changes Dec 12, 2019

View reviewed changes

app/assets/v2/js/grants/detail.js Outdated Show resolved Hide resolved

app/assets/v2/js/grants/new.js Outdated Show resolved Hide resolved

app/grants/models.py Outdated Show resolved Hide resolved

thelostone-mc requested changes Dec 14, 2019

View reviewed changes

thelostone-mc mentioned this pull request Dec 15, 2019

Category tagging on Gitcoin Grants #5456

Closed

2 tasks

sirlupinwatson approved these changes Dec 16, 2019

View reviewed changes

sirlupinwatson reviewed Dec 21, 2019

View reviewed changes

sirlupinwatson reviewed Dec 24, 2019

View reviewed changes

vince0656 added 2 commits February 6, 2020 21:50

Merge branch 'master' of https://github.com/gitcoinco/web into catego…

fc2ff9c

…ry-tagging

Updated migration to fix broken build issues

48298fa

Bug fixes enabling creation and updating of a grants category

6fbe0d9

vince0656 added 2 commits February 9, 2020 20:56

Added unit test for fetching categories from the api

b17453b

test category retrieval using basic_grant_categories

4f24515

vince0656 requested a review from octavioamu February 9, 2020 21:41

thelostone-mc added the grants_round_5 label Feb 11, 2020

danlipert approved these changes Feb 20, 2020

View reviewed changes

octavioamu approved these changes Feb 20, 2020

View reviewed changes

thelostone-mc approved these changes Feb 20, 2020

View reviewed changes

thelostone-mc merged commit 45989e3 into gitcoinco:master Feb 20, 2020

thelostone-mc mentioned this pull request Mar 5, 2020

bug: fix up grant category #6153

Merged

8 tasks

vince0656 mentioned this pull request Mar 7, 2020

Category field converted to drop down which allows selecting multiple #6173

Closed

Grant categories for new grants #5615

Grant categories for new grants #5615

Conversation

vince0656 commented Dec 8, 2019 • edited Loading

Description

Refers/Fixes

Testing

Video Demonstration

codecov bot commented Dec 11, 2019 • edited Loading

Codecov Report

sirlupinwatson left a comment

Choose a reason for hiding this comment

sirlupinwatson commented Dec 12, 2019

owocki left a comment

Choose a reason for hiding this comment

thelostone-mc commented Dec 14, 2019

vince0656 commented Dec 14, 2019

thelostone-mc left a comment • edited Loading

Choose a reason for hiding this comment

thelostone-mc commented Dec 15, 2019

sirlupinwatson left a comment

Choose a reason for hiding this comment

owocki commented Dec 16, 2019

vince0656 commented Dec 16, 2019

owocki commented Dec 16, 2019 via email

thelostone-mc commented Dec 18, 2019

vince0656 commented Dec 18, 2019

vince0656 commented Dec 18, 2019

owocki commented Dec 18, 2019

vince0656 commented Dec 19, 2019

vince0656 commented Dec 19, 2019

vince0656 commented Dec 19, 2019

thelostone-mc commented Dec 19, 2019

owocki commented Dec 19, 2019

sirlupinwatson left a comment

Choose a reason for hiding this comment

sirlupinwatson left a comment

Choose a reason for hiding this comment

thelostone-mc commented Dec 26, 2019

vince0656 commented Dec 29, 2019

thelostone-mc commented Feb 5, 2020

vince0656 commented Feb 6, 2020

vince0656 commented Feb 7, 2020

vince0656 commented Feb 8, 2020

vince0656 commented Feb 9, 2020

owocki commented Mar 2, 2020

danimesq commented Mar 2, 2020 • edited Loading

vince0656 commented Mar 2, 2020

vince0656 commented Mar 2, 2020

vince0656 commented Mar 2, 2020

owocki commented Mar 2, 2020

vince0656 commented Mar 6, 2020

owocki commented Mar 23, 2020

vince0656 commented Dec 8, 2019 •

edited

Loading

codecov bot commented Dec 11, 2019 •

edited

Loading

thelostone-mc left a comment •

edited

Loading

danimesq commented Mar 2, 2020 •

edited

Loading