From c5960c0ea7d52ce2191684ccdbf78ba8064a2275 Mon Sep 17 00:00:00 2001 From: Terje Sandstrom Date: Sat, 24 Feb 2024 14:47:12 +0100 Subject: [PATCH 1/4] Prepare version 4.1 --- CHANGES.md | 5 +++++ CONTRIBUTING.md | 16 +++++++++------- LICENSE.txt | 2 +- build.cake | 11 +++-------- nuget/framework/nunit.nuspec | 2 +- 5 files changed, 19 insertions(+), 17 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 29283b96b6..7c9147ec2b 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,3 +1,8 @@ + +For further changes, see [release notes](https://docs.nunit.org/articles/nunit/release-notes/framework.html) + +------- + ## NUnit 4.0.0 - November 26, 2023 All changes, see [release notes](https://docs.nunit.org/articles/nunit/release-notes/framework.html#nunit-400) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c50fe94d21..a17aef738d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,17 +11,17 @@ Requests for new features and bug reports keep the project moving forward. ### Before you submit an issue - Ensure you are running the [latest version](https://github.com/nunit/nunit/releases) of NUnit. -- **Many 3rd party test runners do not support NUnit 3 yet.** They may appear to run NUnit tests, but they do not do so correctly. -- To ensure that the bug is in NUnit and not in the runner you are using, **test your bug using the nunit3-console.exe** first. +- **Many 3rd party test runners do not support NUnit 3/4 yet.** They may appear to run NUnit tests, but they do not do so correctly. +- To ensure that the bug is in NUnit and not in the runner you are using, **test your bug using dotnet test, nunit3-console or nunitlite** first. - **Search** the [issue list](https://github.com/nunit/nunit/issues?utf8=%E2%9C%93&q=is%3Aissue) (including closed issues) to make sure it hasn't already been reported. ### Submitting a good issue - Give the issue a short, clear title that describes the bug or feature request -- Include what version of NUnit you are using -- Tell us how you are running your tests including command line arguments for the console runner +- Include what version of NUnit you are using, which runner you are using +- Tell us how you are running your tests including command line arguments or runsettings - Include steps to reproduce the issue -- If possible, include a short code example that reproduces the issue +- Include a short code example that reproduces the issue - Use [markdown formatting](https://guides.github.com/features/mastering-markdown/) as appropriate to make the issue and code more readable. ## Confirming Issues @@ -38,14 +38,16 @@ If you’re getting ready to report a bug in NUnit, figuring out how to create a ## Documentation -Great documentation is essential for any open source project and NUnit is no exception. [Our documentation](https://docs.nunit.org/articles/nunit/intro.html) often lags behind the features that have been implemented or would benefit from better examples. +Great documentation is essential for any open source project and NUnit is no exception. -A great place to start is by going through the [NUnit release notes](https://github.com/nunit/docs/wiki/Release-Notes) and ensuring that the documentation for new features is up to date. +[Our documentation](https://docs.nunit.org/articles/nunit/intro.html) often lags behind the features that have been implemented or would benefit from better examples. ## Fixing Bugs and Adding Features We love pull requests, but would prefer that new contributors start with smaller issues and let us know before you contribute to prevent duplication of work. +Ensure you do have an issue to connect your pull request to. If there isn't one, please open a new issue first, and state you have a fix before embarking on the pull request. + To help new contributors get their feet wet, we have marked a number of issues with the `good first issue` label. These are great places to start. It is also a good idea to add a comment to an issue that you are working on to let everyone know. If you stop working on it, also please let us know. diff --git a/LICENSE.txt b/LICENSE.txt index 7eb103cffd..365de41ec3 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,4 +1,4 @@ -Copyright (c) 2023 Charlie Poole, Rob Prouse +Copyright (c) 2024 Charlie Poole, Rob Prouse Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/build.cake b/build.cake index 9b89fda31b..1b4c56c79f 100644 --- a/build.cake +++ b/build.cake @@ -6,8 +6,6 @@ var target = Argument("target", "Default"); var configuration = Argument("configuration", "Release"); -var modifier = Argument("modifier", "-alocal"); -var prerelease = Argument("prerelease", ""); ////////////////////////////////////////////////////////////////////// // SET ERROR LEVELS @@ -19,12 +17,9 @@ var ErrorDetail = new List(); // SET PACKAGE VERSION ////////////////////////////////////////////////////////////////////// -// var version = "4.1.0"; - -var version = MinVer(); - -// var dbgSuffix = configuration.ToLower() == "debug" ? "-dbg" : ""; -// var packageVersion = version + modifier + dbgSuffix; +var version = MinVer(settings=> settings + .WithAutoIncrement(MinVerAutoIncrement.Minor) +); var packageVersion = version; diff --git a/nuget/framework/nunit.nuspec b/nuget/framework/nunit.nuspec index 62fb03fda0..ef8aae14bf 100644 --- a/nuget/framework/nunit.nuspec +++ b/nuget/framework/nunit.nuspec @@ -16,7 +16,7 @@ NUnit is a unit-testing framework for all .NET languages. It can run on macOS, Linux and Windows operating systems. - NUnit can be used for a wide range of testing, from unit testing with TDD to full fledged system and integration testing. + NUnit can be used for a wide range of testing, from unit testing with TDD to full-fledged system and integration testing. It is a non-opinionated, broad and deep framework with multiple different ways to assert that your code behaves as expected. Many aspects of NUnit can be extended to suit your specific purposes. The latest version, version 4, is an upgrade from the groundbreaking NUnit 3 framework. It is a modernized version, aimed at taking advantage of the latest .NET features and C# language constructs. From 535144319f38d7df6302a533d5551e8e40d0ff53 Mon Sep 17 00:00:00 2001 From: Terje Sandstrom Date: Sat, 24 Feb 2024 15:00:46 +0100 Subject: [PATCH 2/4] Update CONTRIBUTING.md Co-authored-by: Sean Killeen --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a17aef738d..d00325d27e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ Requests for new features and bug reports keep the project moving forward. - Ensure you are running the [latest version](https://github.com/nunit/nunit/releases) of NUnit. - **Many 3rd party test runners do not support NUnit 3/4 yet.** They may appear to run NUnit tests, but they do not do so correctly. -- To ensure that the bug is in NUnit and not in the runner you are using, **test your bug using dotnet test, nunit3-console or nunitlite** first. +- To ensure that the bug is in NUnit and not in the runner you are using, **test your bug using `dotnet test`, `nunit3-console` or `nunitlite`** first. - **Search** the [issue list](https://github.com/nunit/nunit/issues?utf8=%E2%9C%93&q=is%3Aissue) (including closed issues) to make sure it hasn't already been reported. ### Submitting a good issue From b8f0f408e9f10dc630e88e6f046edb491d20a8a9 Mon Sep 17 00:00:00 2001 From: Terje Sandstrom Date: Sat, 24 Feb 2024 15:01:10 +0100 Subject: [PATCH 3/4] Update CONTRIBUTING.md Co-authored-by: Sean Killeen --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d00325d27e..76d705a097 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,7 @@ Requests for new features and bug reports keep the project moving forward. - Give the issue a short, clear title that describes the bug or feature request - Include what version of NUnit you are using, which runner you are using -- Tell us how you are running your tests including command line arguments or runsettings +- Tell us how you are running your tests including command line arguments or `runsettings` - Include steps to reproduce the issue - Include a short code example that reproduces the issue - Use [markdown formatting](https://guides.github.com/features/mastering-markdown/) as appropriate to make the issue and code more readable. From e95992e4fce58bb7f06a2a692e45e17e718ca2f5 Mon Sep 17 00:00:00 2001 From: Terje Sandstrom Date: Sat, 24 Feb 2024 17:50:39 +0100 Subject: [PATCH 4/4] Update CONTRIBUTING.md Co-authored-by: Sean Killeen --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 76d705a097..b601aaca01 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,7 +46,7 @@ Great documentation is essential for any open source project and NUnit is no exc We love pull requests, but would prefer that new contributors start with smaller issues and let us know before you contribute to prevent duplication of work. -Ensure you do have an issue to connect your pull request to. If there isn't one, please open a new issue first, and state you have a fix before embarking on the pull request. +Ensure you have an issue to connect your pull request to. If there isn't one, please open a new issue first, and state you have a fix before embarking on the pull request. To help new contributors get their feet wet, we have marked a number of issues with the `good first issue` label. These are great places to start.