From e3b348a6258443306d2a278a6c2922c00a16b38d Mon Sep 17 00:00:00 2001 From: Rob Prouse Date: Sat, 5 Dec 2015 11:59:53 -0500 Subject: [PATCH 1/3] Added a CONTRIBUTING file --- CONTRIBUTING.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..8b1b86d991 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,60 @@ +# How to contribute + +So you're thinking about contributing to NUnit? Great! Maintaining and enhancing NUnit is a big job, so **the community's help is really appreciated.** + +Helping out isn't just writing code, it also includes submitting issues, helping confirm issues, working on the website, helping people on the [mailing lists](https://groups.google.com/forum/m/#!forum/nunit-discuss) and improving the documentation. + +## Submitting Issues + +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. +- If you are using the **Portable Framework**, the console runner nor the Visual Studio adapter do not run portable tests yet. You need to create an **NUnitLite** self-executing test or use the [NUnit Xamarin Runners](https://github.com/nunit/nunit.xamarin). +- **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 steps to reproduce the issue +- If possible, 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 + +Before we work on issues, we must confirm them and be able to reproduce them. Confirming issues takes up a great deal of the team's time, so making that job easier is **really appreciated**. + +Issues that need confirmation will have the **confirm** label or be unlabeled and have **no milestone**. You can help us to confirm issues by; + +- Add steps to reproduce the issue +- Create unit tests to demonstrate the issue +- Test issues and provide feedback + +## Documentation + +Great documentation is essential for any open source project and NUnit is no exception. [Our documentation](https://github.com/nunit/nunit/wiki) often lags behind the features that have been implemented or would benefit from better examples. + +A great place to start is by going through the [NUnit release notes](https://github.com/nunit/nunit/wiki/Release-Notes) and ensuring that the documentation for new features is up to date. + +## 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. + +To help new contributors get their feet wet, we have marked a number of issues with the `easyfix` 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. + +Please read through the [NUnit Dev Wiki]() before contributing to understand our coding standards and contribution guidelines. + +## License + +NUnit is under the [MIT license](). By contributing to NUnit, you assert that: + +* The contribution is your own original work. +* You have the right to assign the copyright for the work (it is not owned by your employer, or + you have been given copyright assignment in writing). \ No newline at end of file From 2555dbbf6b32b76b8976ee904c028a2e865bd13c Mon Sep 17 00:00:00 2001 From: Rob Prouse Date: Sat, 5 Dec 2015 12:00:57 -0500 Subject: [PATCH 2/3] Removed the contributors file. We are not maintaining it and the front page of the site points to the GitHub contribution list --- CONTRIBUTORS.md | 31 ------------------------------- 1 file changed, 31 deletions(-) delete mode 100644 CONTRIBUTORS.md diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md deleted file mode 100644 index 17793bf982..0000000000 --- a/CONTRIBUTORS.md +++ /dev/null @@ -1,31 +0,0 @@ -# NUnit 3.0 Contributors # - -The NUnit 3.0 team is led by [Charlie Poole](https://github.com/CharliePoole) and -[Rob Prouse](https://github.com/rprouse). [Terje Sandstrom](https://github.com/OsirisTerje) -maintains the Visual Studio adapters and [Neil Colvin](https://github.com/oznetmaster) -keeps the CF version of the framework on track. - -Other members of the NUnit team are; - -- [Simone Busoli](https://github.com/simoneb) -- [Andreas Schlapsi](https://github.com/aschlapsi) -- [Igor Ziselman](https://github.com/constructor-igor) -- [Vladimir Kloz](https://github.com/voloda) -- [Matthew Moore](https://github.com/acco32) -- [Andrew Gray](https://github.com/agray) -- [Chris Smith](https://github.com/chris-smith-zocdoc) -- [Sergey Popov](https://github.com/psg1234) -- [elksson](https://github.com/elksson) -- [Nikolay Pianikov](https://github.com/NikolayPianikov) - -NUnit would also not be possible without the numerous contributions from the community. A -complete list of contributors since NUnit migrated to Git can be -[found on GitHub](https://github.com/nunit/nunit/graphs/contributors). - -Earlier versions of NUnit were developed by Charlie Poole, James W. Newkirk, Alexei A. Vorontsov, -Michael C. Two and Philip A. Craig. - -We would also like to thank the following people for their contributions and support: -Jamie Cansdale, Cvetomir Todorov, Doug de la Torre, David White, Ethan Smith, Al Gonzalez, -Ron Jeffries and Rob Jeffries. A special acknowledgment needs to be sent to Kent Beck -and Erich Gamma because without their efforts none of this would have been possible. \ No newline at end of file From 0ab2a3838e99b130025b1234a9703d5eeeda8447 Mon Sep 17 00:00:00 2001 From: Rob Prouse Date: Sat, 5 Dec 2015 14:12:54 -0500 Subject: [PATCH 3/3] Updated the solution files --- nunit.sln | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/nunit.sln b/nunit.sln index a1fb705b0d..6745e5ae59 100644 --- a/nunit.sln +++ b/nunit.sln @@ -1,7 +1,7 @@  Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio 14 -VisualStudioVersion = 14.0.23107.0 +VisualStudioVersion = 14.0.24720.0 MinimumVisualStudioVersion = 10.0.40219.1 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "NUnitFramework", "NUnitFramework", "{5D8A9D62-C11C-45B2-8965-43DE8160B558}" EndProject @@ -51,7 +51,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution appveyor.yml = appveyor.yml BUILDING.txt = BUILDING.txt CHANGES.txt = CHANGES.txt - CONTRIBUTORS.md = CONTRIBUTORS.md + CONTRIBUTING.md = CONTRIBUTING.md EngineAndConsoleTests.nunit = EngineAndConsoleTests.nunit global.json = global.json LICENSE.txt = LICENSE.txt