Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve installation section #2058

Merged

Conversation

SabotageAndi
Copy link
Contributor

Types of changes

  • Bug fix (non-breaking change which fixes an issue).
  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • Performance improvement
  • Refactoring (so no functional change)
  • Other (docs, build config, etc)

Checklist:

  • I've added tests for my code. (most of the time mandatory)
  • I have added an entry to the changelog. (mandatory)
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

docs/Installation/Configuration.md Outdated Show resolved Hide resolved
docs/Installation/Configuration.md Outdated Show resolved Hide resolved
docs/Installation/Configuration.md Show resolved Hide resolved
docs/Installation/Installation.md Show resolved Hide resolved
docs/Installation/Installation.md Show resolved Hide resolved
docs/Installation/NuGet-Packages.md Outdated Show resolved Hide resolved
docs/Installation/NuGet-Packages.md Outdated Show resolved Hide resolved
docs/Tools/Generate-Tests-From-MsBuild.md Outdated Show resolved Hide resolved
@SabotageAndi SabotageAndi force-pushed the docs/ImproveInstallationSection branch from 50773d7 to 87fdfb9 Compare July 21, 2020 13:59
@@ -3,7 +3,7 @@
## General

You need to use the MSBuild code behind file generation for SpecFlow 3.0.
Version after SpecFlow 3.3.30 don't need to add the `SpecFlow.Tools.MSBuild.Generation` package anymore to your project, if you are using the `SpecFlow.NUnit`, `SpecFlow.MSTest`, `SpecFlow.xUnit` or `SpecRun.SpecFlow.3-3-0` package.
After version SpecFlow 3.3.30 don't need to add the `SpecFlow.Tools.MSBuild.Generation` package anymore to your project, if you are using the `SpecFlow.NUnit`, `SpecFlow.MSTest`, `SpecFlow.xUnit` or `SpecRun.SpecFlow.3-3-0` package.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For some reason there is no space or line break between the two sentences
image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's strange. Locally the linebreak was there.

@@ -3,7 +3,7 @@
## General

You need to use the MSBuild code behind file generation for SpecFlow 3.0.
Version after SpecFlow 3.3.30 don't need to add the `SpecFlow.Tools.MSBuild.Generation` package anymore to your project, if you are using the `SpecFlow.NUnit`, `SpecFlow.MSTest`, `SpecFlow.xUnit` or `SpecRun.SpecFlow.3-3-0` package.
After version SpecFlow 3.3.30 don't need to add the `SpecFlow.Tools.MSBuild.Generation` package anymore to your project, if you are using the `SpecFlow.NUnit`, `SpecFlow.MSTest`, `SpecFlow.xUnit` or `SpecRun.SpecFlow.3-3-0` package.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion for the second sentence:
Starting with SpecFlow 3.3.30 you don't need to add the "SpecFlow.Tools.MSBuild.Generation package manually to your project, because it is automatically installed with the selected unit test provider package as dependency.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice to link the "unit test provider package" to the details of it (to spare the list and the warning that you need only one of them, etc.), but I did not find a heading/section that we could easily link yet.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a link to the unit test providers page

@SabotageAndi SabotageAndi merged commit 2d63962 into SpecFlowOSS:master Jul 23, 2020
@SabotageAndi SabotageAndi deleted the docs/ImproveInstallationSection branch July 23, 2020 06:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants