Skip to content

Latest commit

 

History

History
25 lines (21 loc) · 1.48 KB

CONTRIBUTORS-GUIDE.md

File metadata and controls

25 lines (21 loc) · 1.48 KB
Raw

Contributor's Guide

Pull Requests

NBuilder does accept pull requests and they are very much appreciated, however there are certain things you can do to make pull requests easier to accept.

  1. Take your fork from the "develop" branch. NBuilder is currently being developed using the git flow branching strategy. "develop" represents "work in progress." Your changes are easier to integrate if they done alongside the other features and changes we are about to release.
  2. Make sure your work is covered by unit tests. If we have to add test coverage to your proposed change, it means more work for us, and longer wait times for you to see your changes integrated into the solution.
  3. Make sure an issue exists on the NBuilder issues page and label your commits with the issue number.
  4. Make sure your change takes effect in each version of the framework that NBuilder provides.
  5. Use the Invoke-EmulateAppVeyor.ps1 script to validate your work prior to submitting your pull request.
    .\Invoke-EmulateAppVeyor.ps1 -Build -Test -Pack
  1. Any new tests must follow this naming convention: MethodName_Scenario_Expectation()
  2. Every class must have a single responsibility. (SOLID Principles)
  3. Every new test must be in Arrange Act Assert form. If touching an existing test in record/replay, convert it to AAA syntax unless it is too time consuming.
  4. The "Foo Bar" convention is not permitted anywhere
  5. American English spellings should be used not British English