Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 6.9 KB

CONTRIBUTING.md

File metadata and controls

63 lines (40 loc) · 6.9 KB
Raw

Contributing

Thanks you for your interest in contributing to Xamarin.Forms! In this document we'll outline what you need to know about contributing and how to get started.

Code of Conduct

Please see our Code of Conduct.

Prerequisite

You will need to complete a Contribution License Agreement before any pull request can be accepted. Review the CLA at https://cla.dotnetfoundation.org/. When you submit a pull request, a CLA assistant bot will confirm you have completed the agreement, or provide you with an opportunitiy to do so.

Contributing Code

Check out A Beginner's Guide for Contributing to Xamarin.Forms.

Bug Fixes

If you're looking for something to fix, please browse open issues. Check for issues tagged help wanted and good first issue.

Follow the style used by the .NET Foundation, with two primary exceptions:

  • We do not use the private keyword as it is the default accessibility level in C#.
  • We use hard tabs over spaces. You can change this setting in VS 2015 via Tools > Options and navigating to Text Editor > C# and selecting the "Keep tabs" radio option.

Read and follow our Pull Request template

Proposals

To propose a change or new feature, review the guidance below and then open an issue using this template.

Non-Starter Topics

The following topics should generally not be proposed for discussion as they are non-starters:

  • Port to WPF/UWP naming
  • Large renames of APIs
  • Large non-backward-compatible breaking changes
  • Platform-Specifics which can be accomplished without changing Xamarin.Forms.Core
  • Avoid clutter posts like "+1" which do not serve to further the conversation

Proposal States

Open

Open proposals are still under discussion. Please leave your concrete, constructive feedback on this proposal. +1s and other clutter posts which do not add to the discussion will be removed.

Accepted

Accepted proposals are proposals that both the community and core Xamarin.Forms agree should be a part of Xamarin.Forms. These proposals are ready for implementation, but do not yet have a developer actively working on them. These proposals are available for anyone to work on, both community and the core Xamarin.Forms team.

If you wish to start working on an accepted proposal, please reply to the thread so we can mark you as the implementor and change the title to In Progress. This helps to avoid multiple people working on the same thing. If you decide to work on this proposal publicly, feel free to post a link to the branch as well for folks to follow along.

What "Accepted" does mean
  • Any community member is welcome to work on the idea.
  • The core Xamarin.Forms team may consider working on this idea on their own, but has not done so until it is marked "In Progress" with a team member assigned as the implementor.
  • Any pull request implementing the proposal will be welcomed with an API and code review.
What "Accepted" does not mean
  • The proposal will ever be implemented, either by a community member or by the core Xamarin.Forms team.
  • The core Xamarin.Forms team is committing to implementing a proposal, even if nobody else does. Accepted proposals simply mean that the core Xamarin.Forms team and the community agree that this proposal should be a part of Xamarin.Forms.
In Progress

Once a developer has begun work on a proposal, either from the core Xamarin.Forms team or a community member, the proposal is marked as in progress with the implementors name and (possibly) a link to a development branch to follow along with progress.

Rejected

Rejected proposals will not be implemented or merged into Xamarin.Forms. Once a proposal is rejected, the thread will be closed and the conversation is considered completed, pending considerable new information or changes..