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.
- 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
- 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_contributionthen checkout the new branch withgit checkout fix/develop/my_contribution. Please avoid working directly on thedevelopbranch.
- Make commits of logical units.
- Check for unnecessary whitespace with
git diff --checkbefore committing. - Make sure your commit messages are in the proper format.
- Make sure you have added the necessary tests for your changes.
- Run build.bat in the root to assure nothing else was accidentally broken.
- We have a resharper layer that applies our coding standards so make sure that you're "all green in reshaper"
- Sign the Contributor License Agreement.
- Push your changes to a feature branch in your fork of the repository.
- Submit a pull request to the NServiceBus repository