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

chore: refactor fetching functions #620

Merged
merged 1 commit into from
Feb 3, 2025
Merged

Conversation

kittybest
Copy link
Collaborator

@kittybest kittybest commented Jan 29, 2025

Description

The name of Application and Project is confusing, meanwhile there are Request and Recipient on the contract, wanna make the name mapped well. Also, there are several functions or interfaces not being used, should be removed.

  • rename Application to Request
  • remove unused functions and structures
  • update api calls
  • test
  • update docs

Related issue(s)

close #545

Confirmation

Important

We do not accept minor grammatical fixes (e.g., correcting typos, rewording sentences) unless they significantly improve clarity in technical documentation. These contributions, while appreciated, are not a priority for merging. If there is a grammatical error feel free to message the team.

@kittybest kittybest added chore Chore tasks frontend Frontend related only labels Jan 29, 2025
@kittybest kittybest self-assigned this Jan 29, 2025
Copy link

vercel bot commented Jan 29, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
maci-platform ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 31, 2025 5:04pm

@crisgarner
Copy link
Member

Instead of request, shouldn't it be "proposal"? I think request is not clear for users. Also, on the glossary we talk about proposals

@kittybest
Copy link
Collaborator Author

kittybest commented Jan 31, 2025

Instead of request, shouldn't it be "proposal"? I think request is not clear for users. Also, on the glossary we talk about proposals

Since it's request on contract, and all the api calls to get or submit application/proposal is actually submit a request, that's why I named it request, but I agree that proposal is more understandable for users.

So maybe, we could name it like this:
proposal: original we called it application, it's actually equal to Add Request (request with type ADD)
project: Recipient with Metadata
metadata: the context of each project
request: including other requests such as Edit Request

how do you think? @ctrlc03 @crisgarner

@crisgarner
Copy link
Member

Instead of request, shouldn't it be "proposal"? I think request is not clear for users. Also, on the glossary we talk about proposals

Since it's request on contract, and all the api calls to get or submit application/proposal is actually submit a request, that's why I named it request, but I agree that proposal is more understandable for users.

So maybe, we could name it like this: proposal: original we called it application, it's actually equal to Add Request (request with type ADD) project: Recipient with Metadata metadata: the context of each project request: including other requests such as Edit Request

how do you think? @ctrlc03 @crisgarner

I think the changes on the API and code make sense, as you mentioned, it's named request, on the UI to the user I would leave it as Proposal, and the proposal calls the add request. The only thing I'm not convinced is with "Project" as in theory, not all proposals will be projects, some times will be yes or no questions.

@ctrlc03
Copy link
Collaborator

ctrlc03 commented Jan 31, 2025

Instead of request, shouldn't it be "proposal"? I think request is not clear for users. Also, on the glossary we talk about proposals

Since it's request on contract, and all the api calls to get or submit application/proposal is actually submit a request, that's why I named it request, but I agree that proposal is more understandable for users.

So maybe, we could name it like this: proposal: original we called it application, it's actually equal to Add Request (request with type ADD) project: Recipient with Metadata metadata: the context of each project request: including other requests such as Edit Request

how do you think? @ctrlc03 @crisgarner

I think it makes sense, though I agree with Cris "concern" on the term Project, which might not always apply. What about Option?

@kittybest kittybest force-pushed the chore/refactor-functions branch from d20a7f1 to 5dcc3e8 Compare January 31, 2025 16:58
@kittybest
Copy link
Collaborator Author

@crisgarner @ctrlc03
I just push the latest commit that mainly just change the request that would be shown to the users on the interface to proposals, keep most of the api calls as request.

And I'm not sure about the projects part. I understand sometimes it could only be different options. How about we make the name project can also be customized? (included in the round metadata) (default is project)

@crisgarner
Copy link
Member

I like the idea, in the self-service, depending on which type of round you are creating the name will change.

@kittybest
Copy link
Collaborator Author

I like the idea, in the self-service, depending on which type of round you are creating the name will change.

I would open an issue for it, let's keep this PR focusing on the application renaming part.

@kittybest kittybest mentioned this pull request Jan 31, 2025
7 tasks
Copy link
Collaborator

@ctrlc03 ctrlc03 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

@kittybest kittybest merged commit ac8f6a1 into main Feb 3, 2025
17 checks passed
@kittybest kittybest deleted the chore/refactor-functions branch February 3, 2025 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Chore tasks frontend Frontend related only
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Chore(interface): re-organize the api calls
3 participants