redbadger / xpf Goto Github PK

A layout framework for XNA on Windows & Windows Phone 7 from Red Badger Consulting. Inspiration is drawn from the WPF and Silverlight XAML stacks, Reactive Extensions is used to keep things nice and fast.

Getting started with Git and GitHub

• People new to GitHub should consider using GitHub for Windows.
• If you decide not to use GHFW you will need to:

1. Set up Git and connect to GitHub
2. Fork the XPF repository

• Finally you should look into git - the simple guide

Once you're familiar with Git and GitHub, clone the repository and run the .\build.cmd script to compile the code and run all the unit tests. You can use this script to test your changes quickly.

Rules for Our Git Repository

• We use "A successful Git branching model". What this means is that:
  • You need to branch off of the develop branch when creating new features or non-critical bug fixes.
  • Each logical unit of work must come from a single and unique branch:
    • A logical unit of work could be a set of related bugs or a feature.
    • You should wait for us to accept the pull request (or you can cancel it) before commiting to that branch again.
• Your code must attain a complete pass StyleCop before submitting a pull request.
• You must write a MSpec specification for your code with at least 90% coverage. One of the following tools can make this simpler:
  • NCrunch - a commercial product that is currently free. Some tests spontaneously fail, possibly due to threading subtleties, re-running the tests a few times usually shows you exactly what is passing. Alternatively confirm the results using the MSpec executable.
  • ReSharper - a commercial product that can be extended with MSpec functionality.
  • The MSpec executable in the repository.
  • The .\build.cmd will also run MSpec after a build. The resulting HTML file will be placed into the output Bin directory.
• A license header on each source file.

Apart from the branching model and code coverage, running the .\build.cmd with 'zero-red' means you can do a pull request.

We will be using pull requests to vet potential contributors; please do not ask for push rights - we will approach you if we feel that you can be trusted with them.

XPF uses the MIT license, which can be found in license.markdown. The gist of the MIT license is that you can use XPF in your closed-source projects, without any encumberances from us. You can freely compile this code and distribute it to customers (whether they are on XBox, Windows, Windows Phone, Linux or Mac) without having to publish your source code anywhere.

Additional Restrictions

• We only accept code that is compatible with the MIT license (essentially, BSD and Public Domain).
• Copying copy-left (GPL-style) code is strictly forbidden.
• The MIT license must be prepended to each source code file as a code comment.
• You are not allowed to copy dissasembled Microsoft WPF or Silverlight code (closed-source/proprietary) into the repository.
• You are not allowed to copy original Mono Moonlight code (LGPL) into the repository.