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

Revise rules and begin to add meta data #200

Merged
merged 7 commits into from
Dec 14, 2024
Merged

Conversation

joeldickson
Copy link
Contributor

@joeldickson joeldickson commented Nov 18, 2024

There 2 changes in this PR.

  1. Update docs
  2. Add metadata about tech debt time to each rule

The second part is about me wanting to collect some more accurate data about how much tech debt is in a system, the reason i want to use the Analyzers for it is i want to be able to enforces as a part of linting creation people to think about how much work it is to fix the things they are flagging, because the person creating the rule will be the best one to make this call.

At the moment its just a simple "Time in minutes" we want to capture so that when we analyze a code base we can get a weighted estimate of how much technical debt for which problems are in there.

This is similar to the approach in software like Sonarqube

Copy link

codecov bot commented Nov 18, 2024

Codecov Report

Attention: Patch coverage is 93.39623% with 14 lines in your changes missing coverage. Please review.

Project coverage is 75.81%. Comparing base (5f5ecf7) to head (c476056).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
...ers/AgodaCustom/AG0011NoDirectQueryStringAccess.cs 71.42% 4 Missing ⚠️
...odaCustom/AG0001DependencyResolverMustNotBeUsed.cs 33.33% 2 Missing ⚠️
...odaCustom/AG0032PreventUseOfBlockingTaskMethods.cs 33.33% 2 Missing ⚠️
...lyzers/AgodaCustom/AG0033PreventUseOfTaskResult.cs 33.33% 2 Missing ⚠️
...yzers/AgodaCustom/AG0035PreventUseOfMachineName.cs 33.33% 2 Missing ⚠️
...om/AG0040WaitUntilStateNetworkIdleMustNotBeUsed.cs 33.33% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #200      +/-   ##
==========================================
+ Coverage   75.21%   75.81%   +0.60%     
==========================================
  Files          70       70              
  Lines        2606     2729     +123     
  Branches      317      317              
==========================================
+ Hits         1960     2069     +109     
- Misses        564      578      +14     
  Partials       82       82              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

doc/AG0006.md Outdated Show resolved Hide resolved
doc/AG0012.md Show resolved Hide resolved
doc/AG0019.md Show resolved Hide resolved
@joeldickson
Copy link
Contributor Author

going to merge in and revise the estimates for tech debt later

@joeldickson joeldickson merged commit 526887a into master Dec 14, 2024
3 checks passed
@joeldickson joeldickson changed the title Revise rules and being to add meta data Revise rules and begin to add meta data Dec 14, 2024
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

Successfully merging this pull request may close these issues.

4 participants