NCAR / NCAR/ADF

Diagnostics needs unit and linter (pylint) tests

Open
#4 1 comment 0 reactions 1 assignee View on GitHub

@nusbaume is already working on this.

Since Apr 20, 2020.

enhancement
Dominant language
Python
Stars
50
Forks
48
Avg merge
1d 23h
Merged PRs (30d)
13

Description

In order to help in the development and maintenance of the CAM diagnostics package, unit tests (either as official python "unittests" or as "doctests") should be developed such that the diagnostics code can be easily tested, including in an automated CI/CD workflow.

Along with this, a method to properly apply the pylint linter program to the CAM diagnostics would also be beneficial, as it would help catch any possible syntax errors, as well as improve readability and portability. Ideally this method can also be automated in a CI/CD workflow, similar to the unit tests.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.