libgit2 / libgit2/libgit2sharp

Contributing: Running tests instruction outdated

Open
#1,799 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
3.5k
Forks
925
PR merge metrics
No merged PRs in 30d

Description

In the contribution guidelines this is mentioned:

Make sure the project builds and all tests pass on your machine by running the buildandtest.cmd script on Windows or buildandtest.sh on Linux/Mac.

Apparently now simply dotnet test is used?

Also:

Having a configured git client that converts line endings to LF. See here..

This is handled by .gitattributes now, isn't it?

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 in the contribution guidelines and compare the documented buildandtest.cmd/buildandtest.sh commands with the current dotnet test workflow. Check .gitattributes and the repository's current build instructions, then update the outdated testing and line-ending guidance so contributors have accurate steps.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, git
Domain
build-system, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.