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: Document SonarQube for the METplus components in the Contributor's Guide #2666

Open
8 of 24 tasks
jprestop opened this issue Aug 29, 2024 · 0 comments
Open
8 of 24 tasks
Assignees
Labels
component: documentation Documentation issue priority: medium Medium Priority reporting: DTC AF METplus Air Force METplus Project requestor: USAF United States Air Force type: task An actionable item of work
Milestone

Comments

@jprestop
Copy link
Collaborator

Describe the Task

Document the SonarQube for the METplus components in the Contributor's Guide, include information such as the workflow details, any non-default settings, how to access, describe “New Code” (all the issues that were found in the code that the developer touched (does not mean that the developer created the problem), and how we should tackle SonarQube check failures (As long as we’re not introducing vulnerabilities and bugs and hopefully reducing code smells that is enough for now; Ensure we remove all vulnerabilities for sure and try to remove the bugs as well. Priority of resolution: vulnerabilities, bugs, then code smells)

Time Estimate

Estimate the amount of work required here.
Issues should represent approximately 1 to 3 days of work.

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

Air Force

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 a METplus-Wrappers-X.Y.Z version, Consider for Next Release, or Backlog of Development Ideas
  • For a METplus-Wrappers-X.Y.Z version, select the METplus-Wrappers-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.
  • Add any new Python packages to the METplus Components Python Requirements table.
  • For any new datasets, an entry to the METplus Verification Datasets Guide.
  • 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: METplus-Wrappers-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 component: documentation Documentation issue priority: medium Medium Priority type: task An actionable item of work requestor: USAF United States Air Force reporting: DTC AF METplus Air Force METplus Project labels Aug 29, 2024
@jprestop jprestop added this to the METplus-6.0.0 milestone Aug 29, 2024
@jprestop jprestop changed the title Documentation: Document the SonarQube for the METplus components in the Contributor's Guide Documentation: Document SonarQube for the METplus components in the Contributor's Guide Aug 29, 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 reporting: DTC AF METplus Air Force METplus Project requestor: USAF United States Air Force type: task An actionable item of work
Projects
Status: 🟢 Ready
Development

No branches or pull requests

2 participants