Add rule for 3rd party library.properties maintainer using "Arduino" #180
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
per1234
added
type: enhancement
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.
|
umbynos
reviewed
May 31, 2021
| name=MaintainerContainsArduino | ||
| version=1.0.0 | ||
| author=Cristian Maglie <c.maglie@example.com>, Pippo Pluto <pippo@example.com> | ||
| maintainer=Cristian "Arduino Wizard" Maglie <c.maglie@example.com> |
umbynos
approved these changes
May 31, 2021
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.