nunit / nunit/docs

Document AOT support within NUnit

Open Beginner friendly
#1,209 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

Some experimentation shows that NUnit framework + NUnitLite runner will work under AOT scenarios today if consumers opt-out of assembly trimming by using the <TrimmerRootAssembly> csproj setting. Ideally, this isn't needed and everything "just works" both at framework-level and any consumers or runners (incl. adapter, console-runner, etc).

I think it might be helpful to start to document the current state and what can be done it make it work today for those who wish to or need to use AOT. The page can evolve over time as our own support evolves.

A minimal, working proof-of-concept can be found: https://github.com/nunit/nunit/issues/5358#issuecomment-5256248999

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 linked minimal working proof of concept and the TrimmerRootAssembly csproj setting. Document the current AOT behavior for NUnit framework and NUnitLite, including the adapter and console runner, and explain the current opt-out needed so the page can evolve with future support.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.