-
-
Notifications
You must be signed in to change notification settings - Fork 12
Add rule for 3rd party library.properties maintainer using "Arduino" #180
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
Conversation
codecov-commenter
commented
May 30, 2021
Codecov Report
@@ Coverage Diff @@ ## main #180 +/- ## ========================================== + Coverage 84.36% 84.40% +0.04% ========================================== Files 43 43 Lines 2986 2994 +8 ========================================== + Hits 2519 2527 +8 Misses 374 374 Partials 93 93
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤣
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
tested and working
3rd party libraries are not maintained by Arduino. Even when 3rd party libraries are based on official libraries, it is best practice for the library.properties `maintainer` field to be updated to reflect the true maintainer of the project. There is already rule LP027 to promote accuracy in documenting maintainership by prohibiting maintainer values that start with "Arduino". However, this might not cover all inaccurate maintainer declarations. For this reason, a new rule (LP057) is added here to prohibit maintainer values in 3rd party libraries from containing the term "Arduino" anywhere (case insensitive). Violations of this rule only result in an error when in "strict" compliance mode.
3rd party libraries are not maintained by Arduino. Even when 3rd party libraries are based on official libraries, it is
best practice for the library.properties
maintainerfield to be updated to reflect the true maintainer of the project.There is already rule LP027 to promote accuracy in documenting maintainership by prohibiting maintainer values that start
with "Arduino". However, this might not cover all inaccurate maintainer declarations. For this reason, a new rule (LP057)
is added here to prohibit maintainer values in 3rd party libraries from containing the term "Arduino" anywhere
(case insensitive). Violations of this rule only result in an error when in "strict" compliance mode.