Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

53 lines (38 loc) · 2.68 KB
Raw

How to contribute

We love getting patches to NServiceBus from our awesome community. Here is a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

Getting Started

  • Make sure you have a GitHub account
  • Create a new issue, assuming one does not already exist.
    • Clearly describe the issue including steps to reproduce when it is a bug.
    • If it is a bug make sure you tell us what version you have encountered this bug on.
  • Fork the repository on GitHub

Required Tooling

  • Visual Studio 2017 Community or higher

Making Changes

  • Create a feature branch from where you want to base your work.
    • This is usually the develop branch since we never do any work off our master branch. The master is always our latest stable release
    • Only target release branches if you are certain your fix must be on that branch.
    • To quickly create a feature branch based on develop; git branch fix/develop/my_contribution then checkout the new branch with git checkout fix/develop/my_contribution. Please avoid working directly on the develop branch.
  • Make commits of logical units.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Make sure your commit messages are in the proper format.
  • Make sure you have added the necessary tests for your changes.
  • We have a resharper layer that applies our coding standards so make sure that you're "all green in reshaper"

Guidelines

Guidelines can be found here.

Submitting Changes

  • Push your changes to a feature branch in your fork of the repository.
  • Submit a pull request to the NServiceBus repository

Pull Request review process

Because NServiceBus.Core sits at the heart of the NServiceBus ecosystem, pull requests are reviewed closely. Pull requests are checked to ensure comprehension by @nservicbus-maintainers and correctness of the code.

This approach has been implemented in an attempt to limit having to undo changes after the fact. Because of the number of downstreams that depend on NServiceBus.Core, a change-undo pattern can lead to increased work for those downstreams and the end users.

As a pull request submitter, you can help speed up the review of your submission by providing as much context about your code as you can. In addition to providing technical context, consider answering questions like "Why is the change being submitted?" and "What problem does it solve?"

Additional Resources