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

Code CleanUp #21

Open
shahzaibk23 opened this issue Sep 20, 2023 · 2 comments
Open

Code CleanUp #21

shahzaibk23 opened this issue Sep 20, 2023 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@shahzaibk23
Copy link
Member

I see many discrepancies in the Code.

We need to structure the codebase at first priority before moving forward any further.

Some necessary changes

  • There are multiple modules for same thing, delete all extra ones keep one original with right name
  • Delete all not needed in future commented code
  • Structure Code and create comments for understandability
  • Remove direct parameters into modules, Use a case class for parameters definition and use it as an implicit parameter in all respective modules

Some basic rules to follow

  • Take Care of indentation
  • Files names start with first letter Capital
  • package name is all small letters
@shahzaibk23 shahzaibk23 added the enhancement New feature or request label Sep 20, 2023
@masfiyan
Copy link
Collaborator

Is I have to also deleted that file which have for same purpose
like mybenes is build by me and benes say translated to chisel from verilog
so I have to delete that one ? which is not in used ?

and like many other components like benesbuffers and others ?

@shahzaibk23
Copy link
Member Author

YES, delete all not-required-anymore components and fix the names of existing modules.

Also, open a PR. So, I can review everything.

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

No branches or pull requests

3 participants