CONTRIBUTING.md

How to contribute

Pull requests

We love your contributions, thanks for taking the time to contribute!

It's really easy to start contributing, just follow these simple steps:

1. Fork the repo:

2. Clone your forked repository and cd into the directory:

git clone git@github.com:airbrake/sharpbrake.git
cd sharpbrake

3. Run the test suite to make sure the tests pass (using Windows PowerShell):

PS> .\build.ps1

Alternatively, run build.bat from the Windows console or double-clicking it. Code coverage report can be checked in sharpbrake\artifacts\<CURRENT_VERSION>\test-results\report\index.html

4. Create a separate branch, commit your work and push it to your fork:

git checkout -b my-branch
git commit -am
git push origin my-branch

5. Run the test suite again (new tests are always welcome).

6. Make a pull request

Submitting issues

Our issue tracker is a perfect place for filing bug reports or discussing possible features. If you report a bug, consider using the following template (copy-paste friendly):

* Sharpbrake version: {YOUR VERSION}
* .NET platform version: {YOUR VERSION}
* Framework name & its version: {YOUR DATA}

#### Airbrake config

    # YOUR CONFIG
    #
    # Make sure to delete any sensitive information
    # such as your project id and project key.

#### Description

{We would be thankful if you provided steps to reproduce the issue, expected &
actual results, any code snippets or even test repositories, so we could clone
it and test}

Build Better Software