microsoft / microsoft/hve-core

Updates to csharp .instruction files

Open Beginner friendly
#2,868 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.5k
Forks
301
Avg merge
3d 3h
Merged PRs (30d)
92

Description

The current csharp instruction files have some inconsistency issues:

csharp-tests.instructions.md

  • specifies xunit, but most agents interpret this as xunit v2, which is deprecated. Update to specify vunit v3
  • test method name format is incompatible with examples. Should be [Given<Context>_]When<Action>_<ExpectedResult>. The Given segment is optional; the When segment may name the method under test.
  • should include guidance to have one assert per test method - example has two. Assert.Equivalent in xunit.v3 also includes null check, so example of assert.notnull is not needed after bump

csharp.instructions.md

  • added additional items to naming to align with csharp-tests instucti9on file and examples

Validated files with waza linter.

csharp.instructions.md

csharp-tests.instructions.md

updated files attached below

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 csharp-tests.instructions.md and csharp.instructions.md, using the attached updated files as the intended reference. Review the testing framework guidance, test naming format, assertion guidance, and naming additions, then validate both files with the waza linter. Done means the files are consistent with the requested examples and the linter passes.

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
Active
Clarity
Clearly specified
Newbie friendliness
84/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.