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

Use AccountRequestUpdateRequest as parameter #13064

Closed
ziqing26 opened this issue Apr 20, 2024 · 4 comments · Fixed by #13068
Closed

Use AccountRequestUpdateRequest as parameter #13064

ziqing26 opened this issue Apr 20, 2024 · 4 comments · Fixed by #13068
Labels
a-CodeQuality Code/design quality-related traits, static analysis c.Task Other non-user-facing works, e.g. refactoring, adding tests good first issue Easy; restricted for first-time contributors

Comments

@ziqing26
Copy link
Contributor

Environment: master

Description of feature/enhancement

Currently the AccountRequestUpdate parameters are passed in as separate parameters (see this link).

We want to change it to take in one type as the parameter, instead of passing every parameters in separately. An example of how a type is passed in to represent all parameters: link

Justification

This refactors the code in a more maintainable way, as developers do not need to update the function parameters every time there is a change. Instead, they can just edit the typescript type.

@ziqing26 ziqing26 added good first issue Easy; restricted for first-time contributors a-CodeQuality Code/design quality-related traits, static analysis c.Task Other non-user-facing works, e.g. refactoring, adding tests labels Apr 20, 2024
Copy link

Good First Issue - Notes for Contributors
This issue is for first-time contributors only. If you are new to TEAMMATES, feel free to submit a PR for this issue.

Please note that we allow only one good first issue per contributor. If you have already made a prior contribution to TEAMMATES, you may wish to take a look at issues with the help wanted tag instead.

We do not assign issues to contributors. If you would like to pick up this issue, do post a comment below to express your interest and check if there is anyone else who is already working on the issue. We will do our best to reply and give you the go-ahead, but if we don't, feel free to submit a PR as long as there is no one else working on it.

To get started, do read through our contributing guidelines carefully, and set up a development environment on your local machine before making a PR.

If you need any clarifications on our developer guide, or are facing issues that are not found in our troubleshooting guide, please post a message in our discussion forum.

@SaquibKhanANU
Copy link

Hello, i am interested in attempting this issue

@Akshay1018
Copy link

Hi @ziqing26 if this issue is not assigned to anyone, you can assign it to me. I can take this up. Thanks

@ziqing26
Copy link
Contributor Author

Hi @SaquibKhanANU and @Akshay1018 , thank you for your interest. Currently there is an open PR by @Stain19 . If that is not merged but closed in the future, feel free to submit PR but for now you might want to look for another good first issue in TEAMMATES. Thank you:)

ziqing26 pushed a commit that referenced this issue Apr 24, 2024
* Update editAccountRequest parameter type to AccountRequestUpdateRequest

* Fixing the lint

* Refatoring editAccountRequest method

---------

Co-authored-by: Cedric Ong <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a-CodeQuality Code/design quality-related traits, static analysis c.Task Other non-user-facing works, e.g. refactoring, adding tests good first issue Easy; restricted for first-time contributors
Projects
None yet
3 participants