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

Clean code architecture #55

Closed
rooparsh opened this issue Oct 5, 2021 · 11 comments
Closed

Clean code architecture #55

rooparsh opened this issue Oct 5, 2021 · 11 comments
Assignees
Labels
enhancement New feature or request hacktoberfest

Comments

@rooparsh
Copy link
Contributor

rooparsh commented Oct 5, 2021

I feel that the project should have a proper architecture and filing system. It's becoming quite tedious and growing out of scope to manage resources.

@acmbot
Copy link

acmbot bot commented Oct 5, 2021

Thanks @rooparsh, for raising the issue! 🙌
One of our team mates will revert on this soon. ✅

@rooparsh
Copy link
Contributor Author

rooparsh commented Oct 5, 2021

If seems ok, assign this issue to me. Will cleanup and rearchitect.

@gaganmalvi
Copy link
Member

Sure, will assign.

@acmbot
Copy link

acmbot bot commented Oct 5, 2021

This issue has been approved by the owner and is open to solve!
@rooparsh got 5 points for this issue! 🎉

@DarthBenro008
Copy link
Member

@rooparsh thanks for taking this up! Do kindly post your ideas to rearchitect the app here and run by the Idea before opening an Pull Request/Getting started to work on it. We might split the issues into smaller issues if required depending upon your proposal

@rooparsh rooparsh mentioned this issue Oct 7, 2021
@rooparsh
Copy link
Contributor Author

rooparsh commented Oct 8, 2021

Hi @DarthBenro008 , if you see currently the project is not properly structured, contributors are creating files in main package itself without any hierarchy and not following any coding guidelines. This in turn is causing confusion about what and where a particular piece of code is.

My proposal is to properly package the modules functionality wise, keep common utils separate and adhere to strict coding guidelines.

I plan to achieve this in sub parts; in first PR, I have targeted proper packaging and modularity. Then I will focus on revamping coding guidelines and then finally removing deprecated stuff.

@DarthBenro008
Copy link
Member

That's great to hear! But could you share what are these "strict coding guidelines" (which guideline to be exact?) and what kind of project structure are you willing to follow? Could you please draw a small architecture diagram on which "module" pertains to which functionality? This would be really great for future contributors to understand the codebase and have a proper architecture of the codebase.

TL;DR: Could you document the architecture pattern that you would be implementing?

@rooparsh
Copy link
Contributor Author

rooparsh commented Oct 8, 2021

@DarthBenro008 For architecture :
final-architecture

Guidelines : https://developer.android.com/kotlin/style-guide

@rooparsh
Copy link
Contributor Author

rooparsh commented Oct 9, 2021

@DarthBenro008 @gaganmalvi Any update on this issue PR ?

@rooparsh
Copy link
Contributor Author

rooparsh commented Oct 13, 2021

Closing issue since Pr is merged here Link

@acmbot
Copy link

acmbot bot commented Oct 13, 2021

Thanks for closing this issue!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request hacktoberfest
Projects
None yet
Development

No branches or pull requests

3 participants