ukaea / ukaea/PROCESS

Document the writing of tests

Open
#1,403 5 comments 0 reactions 1 assignee View on GitHub

@timothy-nunn is already working on this.

Since Jul 7, 2023.

Documentation
Dominant language
Python
Stars
71
Forks
27
Avg merge
2d 18h
Merged PRs (30d)
33

Description

In GitLab by @timothy-nunn on Sep 17, 2021, 11:24

Testing is a critical part of any software, especially complex numerical codes such as PROCESS. A good practice in development is to continually create tests for new changes. It has come to my attention that the process for writing new tests may be slightly unclear. The writing of through tests is something we want to encourage and making the process easier would be positive.

I believe this documentation could come in with my updated "best practices" documentation for f2py wrapping in #1397 coming in as #1398.

  • How to write different types of tests
  • The distinction between different types of tests
  • Good testing practices

@cz1743 Anything missing from the list above? Anything else you find in your test writing that you think could be (better) documented just comment below.

Contributor guide

Open the contributing guide

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.