nunit / nunit/docs

Developer Info Organization

Open
#542 3 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

Once upon a time, what is now the "NUnit Project" (organization) was one big project. That is, there was one GitHub repository, one codebase and one set of standards or practices. That has not been so for a few years.

Initially, each project that we split off kept following the same practices. Very slowly, some things diverged but the documentation didn't follow along. I believe we need to re-think how we handle developer documentation.

One option would be to return to use of independent wikis for each project. That is, docs for users would be on the website, docs for developers in the wiki. I mention this as a fallback only, in case the reorganization below does not seem feasible.

The other option is to restructure the Developer Info section of the docs so that it's clear which docs apply to which projects. I suggest a menu structure like...

Developer Info
    General
    NUnit Framework
    NUnit Engine and Console
    VS Adapter
    Extensions
     etc.

The benefit of this is more for new contributors than for those of us who have been around for a while. A new contributor is inevitably working on some project and it would be nice to find all info about how to work on that project in the same place. It might also encourage us to create more documentation.

The biggest bit of work here is to decide what goes into "General." AFAIK the @nunit/core-team has never imposed any standards on projects, but maybe some can be considered as generally adopted by all the projects. We could make an initial split simply based on the content of each document - some of them refer to projects in their name while others do so in the text itself.

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

Start with the Developer Info section and review each document for references to NUnit projects or generally adopted practices. Decide which content belongs under General versus a project section, then reorganize the documentation so contributors can find project-specific guidance in one place.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
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.