Katkı Yönergeleri
Welcome to the contribution guidelines for the frc-docs project. If you are unfamiliar to writing in the reStructuredText format, please read up on it here.
Önemli
FIRST® sağlanan belgelere ve görüntülere ilişkin tüm hakları saklı tutar. Makaleler/güncellemeler için kredi GitHub commit history. de olacaktır.
Görev Tanımı
WPILib Misyonu, FIRST Robotik ekiplerinin donanım detaylarına odaklanmak yerine oyuna özel yazılım yazmaya odaklanmasını sağlamaktır - “tavanı alçaltmayın, zemini yükseltin”. Sınırlı programlama bilgisine ve/veya mentor deneyimine sahip ekiplerin, daha gelişmiş programlama yeteneklerine sahip ekiplerin yeteneklerini engellemeden olabildiğince başarılı olmasını sağlamak için çalışıyoruz. Kit of Parts kontrol sistemi bileşenlerini doğrudan kütüphane ile destekliyoruz. Ekiplerin belirli bir programlama dili seçerken dezavantajlı durumda kalmaması için her dilin (Java, C ++ ve NI’s LabVIEW) ana özellikleri arasında eşitlik sağlamaya da çalışıyoruz.
Bu belgeler, tüm FIRST Robotics Competition ekipleri için bir öğrenme alanı sağlamaya hizmet eder. Projeye yapılacak katkılar bu temel ilkeleri takip etmelidir.
Topluluk liderliğindeki belgeler. Belge kaynakları halka açık olarak barındırılır ve topluluk katkı sağlayabilir
Yapılandırılmış, iyi biçimlendirilmiş, temiz belgeler. Dokümantasyon hem kaynak hem de yayın açısından temiz ve okunması kolay olmalıdır.
İlgi. Belgeler, FIRST Robotics Competition’a odaklanmalıdır.
Belgelerinizin stiliyle ilgili bilgi için lütfen :ref:`docs/contributing/frc-docs/style-guide:Style Guide`a bakın.
Yayınlama İşlemi
frc-docs, ana sayfa /stable/
ve geliştirme sayfası /latest/
nı yönetmek için özel bir yayınlama işlemi kullanır. Bu akış aşağıda detaylandırılmıştır.
During Season:
Commit made to
main
branch/stable/
ve/latest/
websitesinde güncellendi
End of Season:
Repository is tagged with year, for archival purposes
Sezon Dışı :
stable
branch is locked to the last on-season commitCommit made to
main
branchSadece dokümantasyon sitesinde
/latest/
güncellenir
PR yaratma
PRs should be made to the frc-docs repo on GitHub. They should point to the main
branch and not stable
.
Yeni İçerik Yaratma
frc-docs <https://github.com/wpilibsuite/frc-docs> __ projesine katkıda bulunduğunuz için teşekkür ederiz! Başlamadan önce bilmeniz gereken birkaç şey var!
Makaleler nereye yerleştirilir?
Yeni makalelerin konumu oldukça tartışılabilir bir konu olabilir. Halihazırda bir konu kategorisine giren bağımsız makaleler, belirtilen konu kategorisine yerleştirilmelidir (simülasyonla ilgili belgeler simülasyon bölümüne yerleştirilmelidir). Bununla birlikte, bir makale mevcut iki ayrı bölümü birleştirdiğinde veya bunlara atıfta bulunduğunda işler oldukça karmaşık hale gelebilir. Bu durumda, PR’ı açmadan önce tartışmayı başlatmak için yazara havuzda bir konuyu tema seçmesini tavsiye ederiz.
Not
Tüm yeni makaleler arşivle birleştirilmeden önce bir inceleme sürecinden geçecektir. Bu inceleme süreci WPILib ekibinin üyeleri tarafından yapılacaktır. Yeni Makaleler resmi FIRST destekli Yazılım ve Donanım üzerinde olmalıdır. Resmi olmayan kitaplıklar veya sensörler ile ilgili belgeler kabul edilmeyecektir. Bu incelemenin tamamlanması biraz zaman alabilir, lütfen sabırlı olun.
Bölümler nereye yerleştirilir?
Bölümler, büyük miktarda içerik barındırdıkları için oldukça zordur. Yazara, bir PR açmadan önce tartışma toplamak için <https://github.com/wpilibsuite/frc-docs/issues> __ sayısını açmasını tavsiye ederiz.
Diğer Makaleleri Bağlamak
Makalenin başka bir makalede açıklanan içeriğe atıfta bulunması durumunda, yazar ilk referansta o makaleye bağlantı vermek için elinden geleni yapmalıdır.
Bir aktarma organı rehberinde aşağıdaki içeriğe sahip olduğumuzu hayal edin:
Teams may often need to test their robot code outside of a competition. :ref:`Simulation <link-to-simulation:simulation>` is a means to achieve this. Simulation offers teams a way to unit test and test their robot code without ever needing a robot.
Simulation’ın yalnızca ilk örneğinin nasıl bağlantılı olduğuna dikkat edin. Yazarın izlemesi gereken yapı budur. Bağlantılı bir makalenin farklı içerik konularına sahip olduğu durumlar vardır. Makalede farklı içerik türlerine atıfta bulunuyorsanız, her yeni referansa bir kez bağlantı vermelisiniz (yazarın aksini uygun gördüğü durumlar hariç).