dotnet / dotnet/format

Confusing README.md

Open
#796 1 comment 1 reaction 0 assignees View on GitHub
Question
Dominant language
No language data
Stars
1.9k
Forks
173
Avg merge
10d 13h
Merged PRs (30d)
1

Description

As a new user of this tool I started reading the README.md for how to use the tool since there are no wiki.

The problem is that it at the top states:
**New in v4.0.130203**

And then further bellow is the commands, I wanted to use this:
`dotnet format --fix-style warn`
But got only errors when running, since I have version 4.0.130203.

If I switch from master to the correct release tag then I get to the correct readme for the current version, but I feel that it is not obvious that I need to do that.

I think it would be good to either add a Wiki that is for the current stable release or when the README is updated with new commads etc that is not in the current stable release that the readme clearly states that this is for the development version.

Regards Daniel

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.