วิธีการส่งคำขอดึง

หากต้องการเปลี่ยนแปลงเนื้อหา ให้ส่งคำขอดึง (PR) จากทางแยกของคุณ คำขอดึงจะต้องได้รับการตรวจสอบก่อนจึงจะสามารถรวมเข้าด้วยกันได้ เพื่อให้ได้ผลลัพธ์ที่ดีที่สุด โปรดตรวจสอบรายการตรวจสอบด้านบรรณาธิการก่อนที่จะส่งคำขอดึงข้อมูลของคุณ

การใช้สาขาคอมไพล์

สาขาเริ่มต้นสำหรับ PowerShell-Docs คือสาขา main การเปลี่ยนแปลงที่ทำในสาขาการทำงานจะถูกรวมเข้ากับสาขา main ก่อนที่จะเผยแพร่ สาขา main จะรวมเข้ากับสาขา live ทุกวันธรรมดา เวลา 15:00 น. (เวลาแปซิฟิก) สาขา live ประกอบด้วยเนื้อหาที่เผยแพร่ไปยัง learn.microsoft.com

ก่อนที่จะเริ่มการเปลี่ยนแปลงใดๆ ให้สร้างสาขาการทำงานในสำเนาของที่เก็บ PowerShell-Docs ในเครื่องของคุณ เมื่อทำงานในพื้นที่ ต้องแน่ใจว่าได้ซิงโครไนซ์พื้นที่เก็บข้อมูลในเครื่องของคุณก่อนที่จะสร้างสาขาการทำงานของคุณ สาขาการทำงานควรถูกสร้างขึ้นจากสำเนาที่ทันสมัยของสาขา main

คำขอดึงทั้งหมดควรกำหนดเป้าหมายไปที่สาขา main อย่าส่งการเปลี่ยนแปลงไปยังสาขา live การเปลี่ยนแปลงที่ทำในสาขา main จะถูกรวมเข้ากับ live โดยเขียนทับการเปลี่ยนแปลงใด ๆ ที่เกิดขึ้นกับ live

ทำให้กระบวนการขอดึงทำงานได้ดีขึ้นสำหรับทุกคน

ยิ่งคุณสร้าง PR ได้ง่ายและมีสมาธิมากขึ้นเท่าใด ก็ยิ่งสามารถตรวจสอบและผสานรวมได้รวดเร็วยิ่งขึ้นเท่านั้น

หลีกเลี่ยงคำขอดึงที่อัปเดตไฟล์จำนวนมากหรือมีการเปลี่ยนแปลงที่ไม่เกี่ยวข้อง

หลีกเลี่ยงการสร้าง PR ที่มีการเปลี่ยนแปลงที่ไม่เกี่ยวข้อง แยกการอัปเดตเล็กน้อยในบทความที่มีอยู่ออกจากบทความใหม่หรือการเขียนใหม่ที่สำคัญ ดำเนินการเปลี่ยนแปลงเหล่านี้ในสาขาการทำงานที่แยกจากกัน

การเปลี่ยนแปลงจำนวนมากจะสร้าง PRs ด้วยไฟล์ที่เปลี่ยนแปลงจำนวนมาก จำกัด PR ของคุณไว้ที่ไฟล์ที่เปลี่ยนแปลงสูงสุด 50 ไฟล์ PR ขนาดใหญ่นั้นตรวจสอบได้ยากและมีแนวโน้มที่จะมีข้อผิดพลาดมากกว่า

การเปลี่ยนชื่อหรือการลบไฟล์

เมื่อเปลี่ยนชื่อหรือลบไฟล์จะต้องมีปัญหาที่เกี่ยวข้องกับ PR ปัญหานั้นจะต้องหารือถึงความจำเป็นในการเปลี่ยนชื่อหรือลบไฟล์

หลีกเลี่ยงการเพิ่มหรือเปลี่ยนแปลงเนื้อหาร่วมกับการเปลี่ยนชื่อและลบไฟล์ ไฟล์ใดๆ ที่ถูกเปลี่ยนชื่อหรือลบจะต้องเพิ่มลงในไฟล์การเปลี่ยนเส้นทางทั่วโลก เมื่อเป็นไปได้ ให้อัปเดตไฟล์ใดๆ ที่เชื่อมโยงไปยังเนื้อหาที่ถูกเปลี่ยนชื่อหรือถูกลบ รวมถึงไฟล์ TOC ใดๆ

หลีกเลี่ยงการแก้ไขไฟล์การกำหนดค่าที่เก็บ

หลีกเลี่ยงการแก้ไขไฟล์คอนฟิกูเรชันของที่เก็บ จำกัดการเปลี่ยนแปลงของคุณไปยังไฟล์เนื้อหา Markdown และไฟล์รูปภาพที่รองรับที่จำเป็นสำหรับเนื้อหาหากเป็นไปได้

การแก้ไขไฟล์การกำหนดค่าที่เก็บอย่างไม่ถูกต้องอาจทำให้โครงสร้างเสียหาย ก่อให้เกิดช่องโหว่หรือปัญหาในการเข้าถึง หรือละเมิดมาตรฐานขององค์กร ไฟล์คอนฟิกูเรชันที่เก็บคือไฟล์ใดๆ ที่ตรงกับรูปแบบเหล่านี้ตั้งแต่หนึ่งรูปแบบขึ้นไป:

*.yml

.github/**

.localization-config

.openpublishing*

LICENSE*

reference/docfx.json

reference/mapping/**

tests/**

ThirdPartyNotices

tools/**

เพื่อความปลอดภัย หากคุณเชื่อว่าคุณค้นพบจุดบกพร่องหรือการปรับปรุงที่อาจเกิดขึ้นสำหรับไฟล์การกำหนดค่าพื้นที่เก็บข้อมูล ให้แจ้งปัญหา ผู้ดูแลจะตรวจสอบและดำเนินการแก้ไขหรือปรับปรุงตามความจำเป็น

ใช้เทมเพลต PR

เมื่อคุณสร้าง PR เทมเพลตจะถูกแทรกลงในเนื้อหา PR สำหรับคุณโดยอัตโนมัติ ดูเหมือนว่านี้:

# PR Summary

<!--
    Delete this comment block and summarize your changes and list
    related issues here. For example:

    This changes fixes problem X in the documentation for Y.

    - Fixes #1234
    - Resolves #1235
-->

## PR Checklist

<!--
    These items are mandatory. For your PR to be reviewed and merged,
    ensure you have followed these steps. As you complete the steps,
    check each box by replacing the space between the brackets with an
    x or by clicking on the box in the UI after your PR is submitted.
-->

- [ ] **Descriptive Title:** This PR's title is a synopsis of the changes it proposes.
- [ ] **Summary:** This PR's summary describes the scope and intent of the change.
- [ ] **Contributor's Guide:** I have read the [contributors guide][contrib].
- [ ] **Style:** This PR adheres to the [style guide][style].

<!--
    If your PR is a work in progress, please mark it as a draft or
    prefix it with "(WIP)" or "WIP:"

    This helps us understand whether or not your PR is ready to review.
-->

[contrib]: /powershell/scripting/community/contributing/overview
[style]: /powershell/scripting/community/contributing/powershell-style-guide

ในส่วน "สรุปการประชาสัมพันธ์" ให้เขียนสรุปสั้นๆ เกี่ยวกับการเปลี่ยนแปลงของคุณ และแสดงรายการปัญหาที่เกี่ยวข้องตามหมายเลขปัญหา เช่น #1234 หาก PR ของคุณแก้ไขหรือแก้ไขปัญหาได้ ให้ใช้ฟีเจอร์การปิดอัตโนมัติของ GitHub เพื่อให้ปัญหาถูกปิดโดยอัตโนมัติเมื่อ PR ของคุณถูกรวมเข้าด้วยกัน

ตรวจสอบรายการในส่วน "รายการตรวจสอบ PR" และทำเครื่องหมายออกเมื่อคุณทำแต่ละรายการเสร็จแล้ว คุณต้องปฏิบัติตามคำแนะนำและตรวจสอบแต่ละรายการเพื่อให้ทีมงานอนุมัติ PR ของคุณ

หาก PR ของคุณอยู่ในระหว่างดำเนินการ ให้ตั้งค่าเป็นโหมดร่างหรือเติมชื่อ PR ของคุณด้วย WIP

ความคาดหวัง

หลังจากที่คุณส่ง PR ของคุณ บอทจะแสดงความคิดเห็นใน PR ของคุณเพื่อจัดหาทรัพยากรให้กับคุณ และเพื่อกำหนดความคาดหวังสำหรับกระบวนการที่เหลือ ตรวจสอบความคิดเห็นนี้เสมอ แม้ว่าคุณจะเคยมีส่วนร่วมมาก่อนก็ตาม เนื่องจากมีข้อมูลที่ถูกต้องและเป็นปัจจุบัน

บริการตรวจสอบเอกสาร PR

บริการตรวจสอบความถูกต้องของ Docs PR คือแอป GitHub ที่เรียกใช้กฎการตรวจสอบการเปลี่ยนแปลงของคุณ คุณต้องแก้ไขข้อผิดพลาดหรือคำเตือนที่รายงานโดยบริการตรวจสอบความถูกต้อง

คุณจะเห็นพฤติกรรมต่อไปนี้:

1. คุณส่ง PR.

2. ในความคิดเห็น GitHub ที่ระบุสถานะของ PR ของคุณ คุณจะเห็นสถานะของ "การตรวจสอบ" ที่เปิดใช้งานบนพื้นที่เก็บข้อมูล ในตัวอย่างนี้ มีการเปิดใช้งานการตรวจสอบสองรายการ "Commit Validation" และ "OpenPublishing.Build":

   

   บิลด์สามารถผ่านได้แม้ว่าการตรวจสอบยืนยันการคอมมิตจะล้มเหลวก็ตาม

3. คลิกรายละเอียดเพื่อดูข้อมูลเพิ่มเติม

4. ในหน้ารายละเอียด คุณจะเห็นการตรวจสอบความถูกต้องทั้งหมดที่ล้มเหลว พร้อมข้อมูลเกี่ยวกับวิธีแก้ไขปัญหา

5. เมื่อการตรวจสอบเสร็จสมบูรณ์ ความคิดเห็นต่อไปนี้จะถูกเพิ่มไปยัง PR:

   

เมื่อ PR ได้รับการตรวจสอบแล้ว คุณอาจถูกขอให้ทำการเปลี่ยนแปลงหรือแก้ไขข้อความเตือนการตรวจสอบความถูกต้อง ทีม PowerShell-Docs สามารถช่วยให้คุณเข้าใจข้อผิดพลาดในการตรวจสอบและข้อกำหนดด้านบรรณาธิการได้

การดำเนินการ GitHub

การดำเนินการ GitHub ที่แตกต่างกันหลายอย่างจะทำงานกับการเปลี่ยนแปลงของคุณเพื่อตรวจสอบและให้บริบทสำหรับคุณและผู้ตรวจสอบ

การตรวจสอบรายการตรวจสอบ

หาก PR ของคุณไม่ได้อยู่ในโหมดร่างและไม่ได้ขึ้นต้นด้วย WIP GitHub Action จะตรวจสอบ PR ของคุณเพื่อตรวจสอบว่าคุณได้ตรวจสอบทุกรายการในรายการตรวจสอบของเทมเพลต PR แล้ว หากการตรวจสอบนี้ล้มเหลว ทีมจะไม่ตรวจสอบหรือรวม PR ของคุณ รายการตรวจสอบมีผลบังคับใช้

การตรวจสอบการอนุญาต

หาก PR ของคุณกำหนดเป้าหมายไปที่สาขา สด หรือแก้ไขไฟล์การกำหนดค่าพื้นที่เก็บข้อมูล GitHub Action จะตรวจสอบสิทธิ์ของคุณเพื่อยืนยันว่าคุณได้รับอนุญาตให้ส่งการเปลี่ยนแปลงเหล่านั้น

เฉพาะผู้ดูแลระบบพื้นที่เก็บข้อมูลเท่านั้นที่ได้รับอนุญาตให้กำหนดเป้าหมายสาขา สด หรือแก้ไขไฟล์การกำหนดค่าของพื้นที่เก็บข้อมูล

การรายงานการเปลี่ยนแปลงเนื้อหาเวอร์ชัน

หาก PR ของคุณเพิ่ม ลบ หรือแก้ไขเนื้อหาที่มีเวอร์ชันใดๆ GitHub Action จะวิเคราะห์การเปลี่ยนแปลงของคุณและเขียนรายงานโดยสรุปประเภทของการเปลี่ยนแปลงที่ทำกับเนื้อหาที่มีเวอร์ชัน

รายงานนี้มีประโยชน์ในการดูว่ามีไฟล์เวอร์ชันอื่นที่คุณแก้ไขหรือไม่ และเวอร์ชันเหล่านั้นได้รับการอัปเดตในชุดการแก้ไขด้วยหรือไม่

หากต้องการค้นหารายงานเนื้อหาเวอร์ชันสำหรับ PR ของคุณ:

1. เลือกแท็บ "ตรวจสอบ" บนหน้า PR ของคุณ
2. เลือกงาน "การรายงาน" จากรายการงาน
3. เลือกปุ่ม "..." ที่มุมขวาบน
4. เลือก "ดูสรุปงาน"

ขั้นตอนต่อไป

คู่มือสไตล์ PowerShell-Docs

แหล่งข้อมูลเพิ่มเติม

วิธีที่เราจัดการคำขอดึง