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

Documentation: Add SonarQube Code Recommendations to Contributor Guide #2956

Open
7 of 22 tasks
jprestop opened this issue Mar 2, 2024 · 0 comments
Open
7 of 22 tasks
Assignees
Labels
component: documentation Documentation issue priority: medium Medium Priority requestor: USAF United States Air Force type: task An actionable item of work
Milestone

Comments

@jprestop
Copy link
Collaborator

jprestop commented Mar 2, 2024

Describe the Task

SonarQube provides recommendations for cleaner code and Howard has been implementing these changes. For example:

  • Do NOT use parentheses in return statements anymore.
  • Minimum scope for local variables. Move local vars as close to their use as possible.
  • Use nullptr instead of 0 to initialize pointers.
  • Prefer strings to character arrays.

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.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

None

Funding Source

See @michelleharrold for FY2025 AF charging guidance.

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required

Labels

  • Review default alert labels
  • Select component(s)
  • Select priority
  • Select requestor(s)

Milestone and Projects

  • Select Milestone as the next official version or Backlog of Development Ideas
  • For the next official version, select the MET-X.Y.Z Development project

Define Related Issue(s)

Consider the impact to the other METplus components.

Task Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    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
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@jprestop jprestop added type: task An actionable item of work alert: NEED ACCOUNT KEY Need to assign an account key to this issue component: documentation Documentation issue component: code cleanup Code cleanup and maintenance issue priority: medium Medium Priority requestor: METplus Team METplus Development Team labels Mar 2, 2024
@jprestop jprestop changed the title Add SonarQube Standards to Contributor Guide Add SonarQube Code Recommendations to Contributor Guide Mar 2, 2024
@jprestop jprestop transferred this issue from dtcenter/MET Aug 29, 2024
@jprestop jprestop added requestor: USAF United States Air Force and removed alert: NEED ACCOUNT KEY Need to assign an account key to this issue component: code cleanup Code cleanup and maintenance issue requestor: METplus Team METplus Development Team labels Aug 29, 2024
@jprestop jprestop changed the title Add SonarQube Code Recommendations to Contributor Guide Documentation: Add SonarQube Code Information and Recommendations to Contributor Guide Aug 29, 2024
@jprestop jprestop changed the title Documentation: Add SonarQube Code Information and Recommendations to Contributor Guide Documentation: Add SonarQube Code Recommendations to Contributor Guide Aug 29, 2024
@jprestop jprestop transferred this issue from dtcenter/METplus Aug 29, 2024
@jprestop jprestop added this to the MET 12.0.0 milestone Aug 29, 2024
@jprestop jprestop added alert: NEED ACCOUNT KEY Need to assign an account key to this issue and removed alert: NEED ACCOUNT KEY Need to assign an account key to this issue labels Aug 29, 2024
@jprestop jprestop modified the milestones: MET-12.0.0, MET-12.1.0 Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue priority: medium Medium Priority requestor: USAF United States Air Force type: task An actionable item of work
Projects
Status: 🟢 Ready
Development

No branches or pull requests

2 participants