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

Refactor ModbusMaster.cs #3

Open
setamodius opened this issue Feb 15, 2019 · 0 comments
Open

Refactor ModbusMaster.cs #3

setamodius opened this issue Feb 15, 2019 · 0 comments

Comments

@setamodius
Copy link
Owner

I've selected ModbusMaster.cs for refactoring, which is a module that has 2 instance(s) of code in comments (1, 2). Addressing this will make our codebase more maintainable and improve Better Code Hub's Write Clean Code guideline rating! 👍

Here's the gist of this guideline:

  • Definition 📖
    Apply The Boy Scout Rule and fix "code smells" in the codebase.
  • Why
    Clean code is maintainable code.
  • How 🔧
    Remove useless comments, commented code blocks, and dead code. Refactor poorly handled exceptions, magic constants, and poorly named units or variables.

You can find more info about this guideline in Building Maintainable Software. 📖


ℹ️ To know how many other refactoring candidates need addressing to get a guideline compliant, select some by clicking on the 🔲 next to them. The risk profile below the candidates signals (✅) when it's enough! 🏁


Good luck and happy coding! :shipit: ✨ 💯

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

No branches or pull requests

1 participant