Contributing.md

#Contribution Guide for MyHome2013

First off: thank you for showing intrest in this project.

Table of Contents

• Coding Guidelines
• Contributing
  • General
  • Issues
  • Pull Requests
  • Features
• Areas of Focus

Coding Guidelines

• Microsoft Guidelines for C#.
• Use LINQ Extension Methods over query syntax.

var result = list.Where(y => y.x); //Use this
result = from y in z // Not this
   	  where y.x
		  select y;

• Use XML style comments on functions, ``properties`, ect.
• Take the space to write fully informative variable names.
  • Exception: if it is a temporary variable in a small scope.
• CTRl + K + D (auto formating).
• Remove and sort usings.

Contributing

General

• Work should be PR'ed to the Development branch -unless it is for a feature that has a specific branch.
• Please try and add your changes to Changelogs/Changelog-staging.md

Issues

See the Waffle Board to get an idea of what issues are available.

Pull Requests

• Each PR should be connected to an issue.
  • It is okay to open the issue and pull request at the same time.
  • You are more then welcome to open a pull request before you have fully finished the work. Simply please try and remember to preface the PR title with [WIP]

Features

In order to suggest a feature follow the following procedure:

• Open an issue which should contain the following elements:
  • A description.
  • Reasoning for adding the feature.
  • Screenshot/code example where applicable.
  • Extra Credit: Estimation of impact on code base.
• Discuss the feature in the issue.
• Once it is ready, the issue will have the Ready label applied.
• Test your code.
• Keep commits small and with meaningful commit messages.
• Open Pull Request.
• Enjoy the new feature.

Areas of Focus