Contributing

Of course, you’re welcome to fork this repository, make changes, and send a pull request. But if you want to coordinate your work with the others contributing to the project, speak up on the cukes mailing list with what you intend to work on, and I’ll update the Issues list accordingly.

Please observe the following guidelines to make it easy for me to include your changes:

1. Cuke4Nuke bridges the .NET and Ruby worlds. As much as possible, follow .NET conventions in the .NET parts of Cuke4Nuke and Ruby conventions in the Ruby parts. For example, use Pascal case names for namespaces, directories, classes, etc. in .NET. Use lower case with underscores in Ruby. Fixing file and directory case in Git on Windows is a huge pain; please don’t make me do it in order to accept your code.
2. Use tests. Cuke4Nuke is a test tool. It should be a good example of how to use automated tests in an application. Please don’t submit a change without the appropriate (passing) Cucumber scenarios and NUnit tests. At least make it look like you used TDD.
3. Be careful not to introduce a dependency on a .NET framework newer than v3.5 unless you’re building support for multiple .NET versions (which would be fantastic, by the way!). There needs to be a really good reason to break support for Visual Studio 2008 for at least the next year or two.
4. Merge the latest from my Cuke4Nuke master before sending a pull request. Make it as easy as possible for me to apply your changes.