Skip to content

Zapdos should follow MOOSE SQA standards #260

@csdechant

Description

@csdechant

There are multiple software quality assurance (SQA) deficiencies in Zapdos currently. In order for Zapdos to obtain new users and establish connections with other laboratories and industry partners, we should focus on improving code and documentation quality. A lot of these items fit under the general umbrella of SQA. This issue will serve as the umbrella issue for those activities. If a checklist item doesn't fit in the currently available categories, please edit and make a new one!

Undocumented Zapdos Objects

There are several undocumented Zapdos objects within /doc/source that should be updated to enhance user experience with Zapdos. In order to reduce the work load of this issue, there are several planned PRs that addresses the documentation for the following objects:

  • actions
  • auxkernels
  • bcs
  • constraints
  • dgkernels
  • indicators
  • interfacekernels
  • kernels
  • materials
  • postprocessors
  • userobjects

SQA Configuration Changes

Changes to SQA configuration items (which might include changes to error-checking or test specifications, as two examples), should be listed here.

  • Enforcing the requirement documentation on tests

Metadata

Metadata

Assignees

No one assigned

    Labels

    C: Examples / TutorialRelated to examples, tutorials, or V&V (in conjunction with SQA)C: Software Quality AssuranceRelated to the MOOSE-based software quality assurance programT: taskAn enhancement or adjustment to the software

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions