Skip to content

Commit

Permalink
Merge pull request nunit#1116 from nunit/issue-974
Browse files Browse the repository at this point in the history
Add Contributing.md file
  • Loading branch information
CharliePoole committed Dec 5, 2015
2 parents f23197b + 0ab2a38 commit 130ceba
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 33 deletions.
60 changes: 60 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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).
31 changes: 0 additions & 31 deletions CONTRIBUTORS.md

This file was deleted.

4 changes: 2 additions & 2 deletions nunit.sln
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 130ceba

Please sign in to comment.