Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

41 lines (29 loc) · 1.84 KB
Raw

Contributing Guide

InitialState.NET is a part-time effort from a small team, so contributions are welcome!

Dependencies

InitialState.NET was built using Visual Studio 2017 and the .NET Framework 4.6.2. It does not have any dependencies outside of the .NET Framework.

Contributing/Submitting Changes

  • Create a fork from the latest develop branch and name it what you intend to do.
    • Branch names should start with:
      • topic/
      • feature/
      • bugfix/
    • Use one branch per feature/bugfix.
    • Words in the branch name should be hyphen (-) delimited.
    • Example: 
      $ git remote update && git fetch
$ git checkout -b topic/speed-improvements origin/dev
  • Make your changes.
    • Test your changes work locally.
  • Commit your changes.
    • Each commit should be as limited in scope as possible.
    • Ensure your commit messages are concise and explain “why” instead of “what”.
  • Submit a pull request.
    • Make sure your PR is against the develop branch.

Your pull request will serve as a code review. All submissions, including those by project members, require review.

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.