marigold-dev / marigold-dev/deku

[Testing] Convention for test description

Open
#453 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

backlog
Dominant language
OCaml
Stars
82
Forks
17
PR merge metrics
No merged PRs in 30d

Description

Please open an issue for this, but those tests are mostly regression test, they're not trying to enforce failure properties, just to ensure that the cases that we actually care are covered here.

_Originally posted by @EduardoRFS in https://github.com/marigold-dev/deku/pull/444#discussion_r813293134_

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.

Research direction

Start by reading the regression-test discussion referenced from PR #444 and identify which test descriptions the proposed convention should cover. Define the convention and document it where the project keeps testing guidance; done means the intended distinction between regression coverage and failure-property tests is agreed and recorded.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
testing
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.