nunit / nunit/docs

Can we reference code link?

Open
#263 12 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

I was working TDD Katas and found few issues. During my R&D for the issue, I observed that something is missing on Wiki Docs. I will be updating docs, before that I would like to ask - can we add external repository code to make documentation more clear and hands-on?

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

Review the referenced TDD Katas repository and the relevant Wiki Docs guidance to determine whether external repository code links are permitted. Done means the policy is decided and the affected documentation is updated with an approved, clear hands-on reference.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.