Documentation: Add SonarQube Code Recommendations to Contributor Guide #2956
Labels
component: documentation
Documentation issue
priority: medium
Medium Priority
requestor: USAF
United States Air Force
type: task
An actionable item of work
Milestone
Describe the Task
SonarQube provides recommendations for cleaner code and Howard has been implementing these changes. For example:
We'd like to maintain a list of advice to be included in the Contributor’s Guide. We should also consider reviewing older SonarQube PRs for other changes already made that are not included in the list above. Additionally, it would be great if we could find these SonarQube recommendations online and link to these recommendations.
See C++ standard version related rule tags, for example.
Related to #2361. Recommend that they be put in the same chapter.
Time Estimate
<1 day of work
Sub-Issues
Consider breaking the task down into sub-issues.
Relevant Deadlines
None
Funding Source
See @michelleharrold for FY2025 AF charging guidance.
Define the Metadata
Assignee
Labels
Milestone and Projects
Define Related Issue(s)
Consider the impact to the other METplus components.
Task Checklist
See the METplus Workflow for details.
Branch name:
feature_<Issue Number>_<Description>
Pull request:
feature <Issue Number> <Description>
Select: Reviewer(s) and Development issue
Select: Milestone as the next official version
Select: MET-X.Y.Z Development project for development toward the next official release
The text was updated successfully, but these errors were encountered: