nunit / nunit/docs

Add constraint examples as a column to the list of constraints itself

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

Nobody has claimed this yet.

Dominant language
Dockerfile
Stars
600
Forks
158
Avg merge
16h 8m
Merged PRs (30d)
21

Description

Currently, https://docs.nunit.org/articles/nunit/writing-tests/constraints/Constraints.html has the list of constraints, but no practical guide to usage.

As a start, we can add a column to the list of constraints and provide the examples alongside the link to the constraint itself.

Items to cover within Constraints.md (thanks to @OsirisTerje for providing the quick screenshot breakdown):

image

image

image

image

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.

Research direction

Open Constraints.md, corresponding to the constraints list at the linked documentation page, and review the existing rows and the screenshots in the issue. Add a practical-usage column with examples alongside each constraint link for the items shown. Done means the list includes examples for the requested constraints and the documentation renders clearly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.