Skip to content

Latest commit

 

History

History
94 lines (61 loc) · 3.56 KB

CONTRIBUTING.md

File metadata and controls

94 lines (61 loc) · 3.56 KB
Raw

How to Contribute

We love Pull Requests! Your contributions help make WinShared great.

So you want to contribute to WinShared. Great! Contributions take many forms from submitting issues, writing docs, to making code changes. We welcome it all. Don't forget to sign up for a GitHub account, if you haven't already.

Getting Started

You can clone this repository locally from GitHub using the "Clone in Desktop" button from the main project site, or run this command in the Git Shell:

git clone https://github.com/MarkerMetro/MarkerMetro.Unity.WinShared.git WinShared

Make sure you have the correct line endings set on Windows

git config --global core.autocrlf true

If you want to make contributions to the project, forking the project is the easiest way to do this. You can then clone down your fork instead:

git clone https://github.com/MY-USERNAME-HERE/MarkerMetro.Unity.WinShared.git WinShared

How is the codebase organised?

The project's root folder is an Unity project folder, that is, you can browse to it in Unity to open the project.

The WindowsSolution folder contains both folders for Windows Store and Windows Phone. When using Unity, you should build to these folders and open the solution file inside WindowsSolution using Visual Studio to build and deploy to your device. For more information, take a look at the README file.

Making Changes

When you're ready to make a change, create a branch off the master branch. We use master as the default branch for the repository, and it holds the most recent contributions, so any changes you make in master might cause conflicts down the track.

If you make focused commits (instead of one monolithic commit) and have descriptive commit messages, this will help speed up the review process.

Submitting Changes

You can publish your branch by running this command from the Git Shell:

git push origin MY-BRANCH-NAME

Once your changes are ready to be reviewed, publish the branch to GitHub and open a pull request against it.

A few little tips with pull requests:

  • prefix the title with [WIP] to indicate this is a work-in-progress. It's always good to get feedback early, so don't be afraid to open the PR before it's "done".
  • use checklists to indicate the tasks which need to be done, so everyone knows how close you are to done.
  • add comments to the PR about things that are unclear or you would like suggestions on.

Don't forget to mention in the pull request description which issue/issues are being addressed.

Coding Conventions

Some things that will increase the chance that your pull request is accepted.

  • Follow existing code conventions.
  • Update the documentation, the surrounding one, examples elsewhere, guides, whatever is affected by your contribution.

MSDN Coding Guidelines

We follow the MSDN Coding Guidelines for C# with a few exceptions and additions.

Variable Naming Exception

We use an underscore for all private variables, whether instance or static.

Unit Tests

We use the conventions established here in this article.

Commit Messages

To write commit messages we follow the good practices detailed here in this blog post.