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

Refactoring odo in small chunks #4298

Closed
dharmit opened this issue Dec 9, 2020 · 4 comments
Closed

Refactoring odo in small chunks #4298

dharmit opened this issue Dec 9, 2020 · 4 comments
Assignees
Labels
area/refactoring Issues or PRs related to code refactoring
Projects

Comments

@dharmit
Copy link
Member

dharmit commented Dec 9, 2020

What are we doing?

For Sprint 194, we will work on refactoring odo code in small chunks. What this means is that we will try to:

  1. remove functions or code that's repeating across packages/layers but doing (almost) the same thing
  2. break large function that's doing multiple things into smaller functions that are easier to read and understand
  3. add more comments to the code to make it simpler for other contributors to understand
  4. unify repeating code into functions
  5. clean the code iteratively with small and focussed PRs

Why?

Why are we not doing what's suggested/discussed in #4057? What about the refactoring issues like #4081, #4093, #4115, #4145, and more?

We will still be addressing these issues when we're more confident. Yes, we're not enough confident right now to fully embrace Go interfaces and make our code adhere to Go best practices. If you have any ideas/suggestions, or feel like helping out, please do! The goal of odo project still remains the same - to achieve code architecture similar to what's discussed in #4057.

What's the desired outcome of this issue?

Parts of our code were added/developed by contributors who are not active at the moment. While working on this issue we would like to better understand the flow of things across the code instead of limiting ourselves only to the packages we contributed to in the past.

What's the Acceptance Criteria for this issue?

There's no predefined criteria except the points mentioned under "What are we doing?" As we open & merge PRs, we will mention them in the comments on this issue.

@dharmit dharmit added this to For Consideration in Sprint 194 via automation Dec 9, 2020
@dharmit
Copy link
Member Author

dharmit commented Dec 9, 2020

@kadel @mik-dass @adisky let me know if anything about issue description needs to be changed.

@dharmit dharmit moved this from For Consideration to To Do in Sprint 194 Dec 15, 2020
@mik-dass mik-dass moved this from To Do to In Progress in Sprint 194 Dec 21, 2020
@dharmit dharmit added this to For Consideration in Sprint 195 via automation Dec 28, 2020
@dharmit dharmit moved this from For Consideration to To Do in Sprint 195 Dec 30, 2020
@dharmit
Copy link
Member Author

dharmit commented Dec 30, 2020

In Sprint 194, as a part of this issue, I started stepping through the code to understand where we can make improvements. I ended up creating:

And to the best of my knowledge, @mik-dass opened PR 4311.

In Sprint 195, I intend to continue stepping through the code as much as I can. AFAIK, @mik-dass is going to open a PR to refactor storage bits once PR 4311 is merged.

@mik-dass correct me if I'm wrong.

@dharmit dharmit removed this from In Progress in Sprint 194 Dec 30, 2020
@dharmit dharmit removed their assignment Jan 18, 2021
@dharmit dharmit removed this from To Do in Sprint 195 Jan 18, 2021
@dharmit dharmit added this to For Consideration in Sprint 196 via automation Jan 18, 2021
@dharmit
Copy link
Member Author

dharmit commented Feb 8, 2021

/close

@openshift-ci-robot
Copy link
Collaborator

@dharmit: Closing this issue.

In response to this:

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sprint 196 automation moved this from For Consideration to Done Feb 8, 2021
@rm3l rm3l added the area/refactoring Issues or PRs related to code refactoring label Jun 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/refactoring Issues or PRs related to code refactoring
Projects
Archived in project
Development

No branches or pull requests

4 participants