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

Perform general code review #31

Open
pcantera opened this issue Mar 27, 2020 · 0 comments
Open

Perform general code review #31

pcantera opened this issue Mar 27, 2020 · 0 comments

Comments

@pcantera
Copy link
Contributor

pcantera commented Mar 27, 2020

@pcantera commented on Thu Mar 21 2019

Expected Behavior

  • Reuse and refactor functionalities
  • Method names based on verbs
  • Error management normalization
  • Traceability normalization
  • Improve idiomatic coding
  • Reformat package sources
  • Remove dead code
  • Review unhandled errors
  • Error messages normalization
  • Exclude some files from compiling (as some accessory test files)
  • Review exported or unexported methods
  • Exported elements should have comments
  • Remove redundant or unnecessary characters (i.e.: parentheses)
  • Review overlapped variables
  • Review spelling
  • Increase code quality coverage
  • API files: Vector is a bad name, rename to Params

Current Behavior

Possible Solution

Steps to Reproduce (for bugs)

1.
2.
3.
4.

Context and environment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant