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 MarkdownProvider.ts #3

Open
GregTrevellick opened this issue Aug 18, 2018 · 0 comments
Open

Refactor MarkdownProvider.ts #3

GregTrevellick opened this issue Aug 18, 2018 · 0 comments

Comments

@GregTrevellick
Copy link
Owner

I've selected MarkdownProvider.ts for refactoring, which is a module of 92 lines of code and 22 incoming calls. Addressing this will make our codebase more maintainable and improve Better Code Hub's Separate Concerns in Modules guideline rating! 👍

Here's the gist of this guideline:

  • Definition 📖
    Avoid large modules with high fan-in (nr. of incoming calls).
  • Why
    This keeps the codebase loosely coupled which makes it easier to minimize the consequences of changes.
  • How 🔧
    Identify and extract responsibilities of large modules into smaller ones and hide implementation details behind interfaces. Target having modules that have no more than 10 incoming calls.

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