zapdos icon indicating copy to clipboard operation
zapdos copied to clipboard

Zapdos should follow MOOSE SQA standards

Open csdechant opened this issue 1 year ago • 1 comments

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:

  • [x] actions
  • [x] auxkernels
  • [x] bcs
  • [x] constraints
  • [x] dgkernels
  • [x] indicators
  • [x] interfacekernels
  • [x] kernels
  • [x] materials
  • [x] postprocessors
  • [x] 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

csdechant avatar Oct 29 '24 15:10 csdechant

This should also be connected to #221.

cticenhour avatar Apr 11 '25 21:04 cticenhour