Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

72 lines (51 loc) · 3.03 KB
Raw

How to contribute

We would like to keep contributing as easy as possible to contribute changes that get things working on your environment. There are some guidelines that we need contributors to follow so that we can keep on top of things.

Getting Started

  • Make sure you have a GitHub account.
  • Create an Issue for your problem, assuming one does not already exist.
    • Clearly describe the issue including steps to reproduce, stacktrace and environments when it is a bug.
  • Fork the repository on GitHub.
  • After cloning your repogitory to local, you should set git config user.name and git config user.email your@ema.il . Especially you MUST set user.email as same as your GitHub account's e-mail.

Making Changes

  • Create a topic branch from where you want to base your work.
    • It would be usually from the master branch.
  • Make commits of logical units. Do not contain unrelated file changes(e.g. code formatting).
  • Check for unnecessary whitespace with git diff --check before committing.
  • Make sure your commit messages are in the proper format.
Essential commit summary here.

The body paragraph describes the behavior without the patch,
why this is a problem, and how the patch fixes the problem when applied.
  • Make sure you have added the necessary tests for your changes.
  • Run all the tests to assure nothing else was accidentally broken.

Coding Style

We follow the style used by the .NET Foundation, with one primary exception:

We use Allman style braces, where each brace begins on a new line. A single line statement block can go without braces

We always need braces, you can not go without braces.

Examples:

// 👎🏽 DO NOT WRITE
if (source == null) 
    throw new ArgumentNullException("source");

// 👍🏽 GOOD
if (source == null)
{
    throw new ArgumentNullException("source");
}

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the Xam.Forms.Enhanced repository.

Make pull request guide line

  • Write a summary of the changes in easy-to-understand manner for the title.
  • Show some usage or test code for your changes. We storongly recommend to add usage of new feature to the sample apps.
  • Include related issue number for the contents. (e.g. ref #199)
  • If your changes are work in progress, the title should start with [WIP]. If you worked out, delete the [WIP] and please let us know.
    • If we changed the master before you completed the work, you should resolve conflicts.
    • We accept your [WIP] pull request first, which means issue reservation. But if you became no longer active, we will close it.

Thanks

This guide is based on MMP/CONTRIBUTING.en.md · sn0w75/MMP. and on Xamarin.Forms.GoogleMaps contributing.md