Xamarin.Forms新手指南

Xamarin.Forms已經(jīng)開源了一年多了。 那時候，我們已經(jīng)接受了700多次拉取請求并收到了更多的請求。 有沒有這些是你的？ 如果沒有，這是你的參與邀請！ 在本文中，我將概述我們正在尋找什么樣的貢獻(xiàn)，并提供一個指南來提交您的第一個錯誤修復(fù)。

我們接受什么貢獻(xiàn)

簡而言之，我們將招募任何使Xamarin.Forms產(chǎn)品在穩(wěn)定性，質(zhì)量和能力方面更好的產(chǎn)品。 這可能采取以下形式：

1. Bug修復(fù)

2. 功能實(shí)現(xiàn)

3. 測試

4. 自述和維基文章或更新

在GitHub項(xiàng)目開始打開“請求”之前，有一些先決條件。

簽署.NET Foundation Release

當(dāng)您提交提請請求時，.NET Foundation bot將檢查以確保您已經(jīng)簽署了Contribution許可協(xié)議。 如果沒有，系統(tǒng)會提示您這樣做。 在完成之前，我們不能接受任何捐款。

查看編碼樣式要求

除了一些例外，我們堅持使用.NET Foundation風(fēng)格指南：

• 不要使用私有，因?yàn)檫@是默認(rèn)保護(hù)級別。

• 使用硬標(biāo)簽而不是空格

• 將行限制為最多120個字符

有關(guān)在Visual Studio安裝中實(shí)現(xiàn)其中的一些的指導(dǎo)，請查閱我們的自述文件。

讓我們關(guān)注錯誤修復(fù)

你發(fā)現(xiàn)了一個錯誤，并有一個修復(fù)你想貢獻(xiàn)？真棒！ 在您走得太遠(yuǎn)之前，請快速搜索Bugzilla，查看是否有任何相同問題的報告。 在搜索Xamarin.Forms時，選擇“高級搜索”選項(xiàng)，然后：

• Classification: Xamarin

• Product: Xamarin.Forms

• Component: 無或全部搜索廣泛

• Status: 所有的
  

如果存在匹配問題，并且標(biāo)記為“正在進(jìn)行”，則有人已經(jīng)在處理此問題。 如果在該問題上引用了PR，那么可能會在GitHub上等待合并。 當(dāng)問題被解決和修復(fù)時，然后已經(jīng)將Pull請求合并以解決問題。 目前，要查看是否已經(jīng)發(fā)布，您需要在哪個版本中搜索我們的發(fā)行說明。 我們有計劃在未來幾個星期內(nèi)改進(jìn)。

如果在任何其他不完整的狀態(tài)有錯誤，或沒有錯誤報告，那么你運(yùn)氣好，準(zhǔn)備繼續(xù)！

Xamarin.Forms解決方案

當(dāng)您開始探索Xamarin.Forms解決方案時，可能看起來很難過。 我會為你揭開神秘面紗，并告訴你在哪里注意力。

Control Gallery/
這些項(xiàng)目包括一個畫廊應(yīng)用程序，包括所有可用的Xamarin.Forms控件，更重要的是使用UITEST內(nèi)聯(lián)的主機(jī)錯誤復(fù)制。 在修復(fù)錯誤時，或者只是為了調(diào)查控件是如何工作的，這個裸骨頭但是功能性的應(yīng)用程序是你想要看的地方。

Pages Gallery/
顧名思義，這是另一個庫應(yīng)用程序，但這次是DataPages實(shí)現(xiàn)。

Platforms/
這些項(xiàng)目包含平臺特定的服務(wù)實(shí)現(xiàn)，最重要的是UI控件。 當(dāng)Xamarin.Forms在iOS上呈現(xiàn)一個Label時，它會運(yùn)行Xamarin.Forms.Platform.iOS/Renderers/LabelRenderer.cs. 在Android上，你會得到Xamarin.Forms.Platform.Android/Renderers/LabelRenderer.cs, 或者如果您使用的是FastRenderers Xamarin.Forms.Platform.Android/FastRenderers/LabelRenderer.cs. 當(dāng)添加控件或修復(fù)控件相關(guān)的錯誤時，這將是您實(shí)現(xiàn)這些更改的位置。

Xamarin.Forms/
在查找抽象控件，布局，綁定，觸發(fā)器，應(yīng)用鏈接和其他非平臺特定代碼的核心實(shí)現(xiàn)時，搜索這些項(xiàng)目。

Xamarin.Forms.Maps/ and Xamarin.Forms.Xaml/
這些文件夾是不言自明的。 你可能不會花太多時間在這些項(xiàng)目中，除非你真的明白這些領(lǐng)域。

Fixing a Bug

• Clone the Xamarin.Forms code from GitHub master branch or pull to make sure you have the latest.

• Create a new branch to host your changes

• Open the Xamarin.Forms solution and navigate to the Control Gallery > Xamarin.Forms.Controls.Issues > Xamarin.Forms.Controls.Issues.Shared

• Use the _Template.cs to start a new case following the established naming convention of “Bugzilla######.cs” where ###### is the issue id in Bugzilla.

using Xamarin.Forms.CustomAttributes;
using Xamarin.Forms.Internals;

#if UITEST
using Xamarin.UITest;
using NUnit.Framework;
#endif

namespace Xamarin.Forms.Controls.Issues
{
	[Preserve(AllMembers = true)]
	[Issue(IssueTracker.Bugzilla, 1, "Issue Description", PlatformAffected.Default)]
	public class Bugzilla1 : TestContentPage // or TestMasterDetailPage, etc ...
	{
		protected override void Init()
		{
			// Initialize ui here instead of ctor
			Content = new Label
			{
				AutomationId = "IssuePageLabel",
				Text = "See if I'm here"
			};
		}

#if UITEST
		[Test]
		public void Issue1Test ()
		{
			RunningApp.Screenshot ("I am at Issue 1");
			RunningApp.WaitForElement (q => q.Marked ("IssuePageLabel"));
			RunningApp.Screenshot ("I see the Label");
		}
#endif
	}
}

在這里實(shí)現(xiàn)您的繁殖情況。 如果是一個更復(fù)雜的案例，請參考本項(xiàng)目中的其他問題，找到類似的內(nèi)容，并遵循該模式。 最后你應(yīng)該有一個演示，演示你正在努力解決的問題。

• 選擇控制庫目標(biāo)項(xiàng)目以在模擬器或設(shè)備上運(yùn)行。

你應(yīng)該看到你的重生發(fā)生。 如果沒有，那么就會出現(xiàn)這個問題已經(jīng)解決了。

• 實(shí)施你的修復(fù)并重新測試。

• 在再現(xiàn)文件中實(shí)現(xiàn)UITest。 如果您不是UITest專業(yè)人員，請再次參考來源中的其他修補(bǔ)程序。 一旦您提交拉動請求，測試將自動運(yùn)行。

您現(xiàn)在可以創(chuàng)建一個拉請求。 在您的IDE或Git工具中，在GitHub上為Xamarin.Forms遠(yuǎn)程創(chuàng)建一個Pull請求。 這個過程應(yīng)該轉(zhuǎn)到GitHub Pull Request頁面，并填入Xamarin.Forms Pull Request模板。 我們要求您填寫您可以做的一切，并省略任何不適用的內(nèi)容。

Description
目前的行為是什么，預(yù)期的行為是什么？

Bugs
列出這適用于的任何和所有Bugzilla報告

API Changes
如果任何類的表面區(qū)域在進(jìn)行此修復(fù)時更改，請注意此處的更改。 這些可能表示其他用戶及其遺留應(yīng)用程序的破壞或行為變化。

Checklist
指示您是否已經(jīng)包括測試。 如果不需要任何測試或使用UITest來測試問題太難，請注意。

就是這樣 提交拉請求，我們將審查。 如果有問題或疑慮，團(tuán)隊將提交意見并提出代碼請求。 這個審查過程可能會感到臨床，所以不要親自去。 對自己說，開源項(xiàng)目的拉扯請求流程是一個很好的學(xué)習(xí)經(jīng)歷，在幾乎每一種情況下，我的貢獻(xiàn)最終都被接受。

如果您將URL復(fù)制到Pull請求并在引用的Bugzilla問題上注意，這對我們和其他用戶也是非常有幫助的。

Adding Features
在開始研究功能之前，請查看公共Xamarin.Forms路線圖，然后搜索Evolution論壇，我們將討論可能的新功能和其他更改的規(guī)范。 如果您沒有看到已經(jīng)覆蓋的功能，請在Evolution論壇上打開一個提案，并提供實(shí)施。 Xamarin.Forms工程小組將審核該提案并提供反饋。

如果您在一個平臺上實(shí)現(xiàn)舒適，但不足以實(shí)現(xiàn)其余平臺，該怎么辦？ 繼續(xù)打開提案，邀請他人參與。

Tests and Wiki
如上所述，我們也歡迎在這些領(lǐng)域的貢獻(xiàn)。 我們有幾個UITEST項(xiàng)目以及單元測試。 我們有相當(dāng)好的覆蓋面，但總是會更好。 測試正確的事情很重要，所以如果你有任何問題請問。

我們的文檔小組繼續(xù)對我們的開發(fā)人員指南和API文檔做出驚人的工作。 如果您發(fā)現(xiàn)任何不準(zhǔn)確或有建議，請使用側(cè)欄中的“我有問題”按鈕，并發(fā)送給我們詳細(xì)信息。

如果您的維基貢獻(xiàn)不符合這些文檔類別，請告訴我們，我們將考慮構(gòu)建維基。

快樂貢獻(xiàn)！

我希望你會考慮為Xamarin.Forms做出貢獻(xiàn)。 沒有什么可以讓您的拉動請求合并，并且知道您剛剛幫助了一個巨大的驚人的開發(fā)人員社區(qū)。

有關(guān)詳細(xì)信息并開始使用：

• open.xamarin.com for more guidance on contributing to Xamarin open source

• github.com/xamarin/Xamarin.Forms

• Evolution forum proposals

• Bugzilla