Membuat template masalah dan permintaan pull

Halaman ini menjelaskan cara membuat dan mengonfigurasi template masalah dan template permintaan pull untuk Secure Source Manager.

Peran yang diperlukan

Untuk mendapatkan izin yang diperlukan untuk menggunakan template masalah dan pull request, minta administrator Anda untuk memberi Anda peran IAM berikut:

Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran kustom atau peran yang telah ditentukan lainnya.

Untuk mengetahui informasi tentang cara memberikan peran Secure Source Manager, lihat Kontrol akses dengan IAM dan Memberikan akses instance kepada pengguna.

Ringkasan template

Template masalah dan pull request memungkinkan Anda menstandardisasi informasi yang diberikan kontributor ke repositori. Template masalah menawarkan opsi yang telah ditentukan yang dapat dipilih pengguna, bergantung pada jenis masalah yang mereka kirimkan dan jenis template yang tersedia. Template permintaan pull diterapkan secara otomatis ke semua permintaan pull, sehingga memastikan kontribusi yang konsisten ke repositori.

Template dapat dibuat oleh siapa saja yang memiliki izin untuk menggabungkan file dalam repositori.

Membuat template masalah

Secure Source Manager memungkinkan Anda menentukan template masalah menggunakan file Markdown di beberapa lokasi dalam repositori Anda. Anda dapat membuat beberapa template masalah untuk tujuan yang berbeda. Misalnya, Anda mungkin ingin memiliki template terpisah untuk melaporkan bug dan mengirimkan permintaan fitur.

  1. Buat template yang dimulai dengan informasi berikut, dalam format yang sama persis ini:

     ---
 name: TEMPLATE_NAME
 about: Insert description of template
 title: Placeholder title for the new issue when it is created
 ---

  2. Berikan nama dan deskripsi. Kolom ini wajib diisi dan digunakan di UI halaman Masalah Baru.

  3. Anda dapat menyertakan judul yang digunakan sebagai judul placeholder saat masalah baru dibuat.

  4. Di bawah materi yang diperlukan, sertakan informasi apa pun yang ingin Anda tampilkan dalam deskripsi masalah yang akan membantu pengguna memberikan informasi yang diperlukan.

  5. Simpan template Anda sebagai file Markdown di salah satu lokasi berikut:

    • /.securesourcemanager/ISSUE_TEMPLATES/
    • /.securesourcemanager/issue_templates/

Template masalah default

Secure Source Manager juga mendukung definisi satu template default. Template ini harus ditentukan di salah satu lokasi berikut:

  • /.securesourcemanager/ISSUE_TEMPLATE.md
  • /.securesourcemanager/issue_template.md

Saat pengguna membuat masalah baru, Secure Source Manager akan meminta pengguna tersebut untuk memilih template, jika ada, atau memilih template default. Jika tidak ada template default yang ditetapkan, tidak ada yang akan diisi otomatis ke dalam masalah baru.

Contoh template Masalah

5 baris pertama template harus mengikuti konvensi yang diuraikan dalam contoh berikut. Informasi tambahan dapat diformat dalam Markdown agar sesuai dengan kebutuhan jenis masalah.

---
name: Bug #Used as UI element for the button on the New Issues page
about: Use this template to submit a new bug #Used as description text on the New Issues page
title: [BUG]: <Describe issue> #Used as placeholder name for newly created issue
---
# Description

# Expected result

# Actual result

# Steps to reproduce
1.
2.

# Environment
-OS:
-Software version:
-Screenshots:

Membuat template permintaan pull

  1. Buat template yang dimulai dengan informasi berikut, dalam format yang sama persis ini:

     ---
 title: "[PR]: <Insert title>"
 ---

  2. Di bawah materi yang diperlukan, sertakan informasi apa pun yang ingin Anda tampilkan dalam deskripsi masalah untuk membantu pengguna memberikan informasi yang diperlukan. Lihat contoh template di bagian berikut untuk mengetahui detail selengkapnya.

  3. Simpan template sebagai file Markdown di salah satu lokasi berikut dalam repositori:

    • /.securesourcemanager/PULL_REQUEST_TEMPLATE.md
    • /.securesourcemanager/pull_request_template.md

Saat Anda membuat permintaan pull baru, Secure Source Manager akan memeriksa apakah ada template di salah satu lokasi yang ditentukan dan memuatnya. Jika Anda menyertakan informasi title dalam template, informasi tersebut akan otomatis diisi dalam pull request baru untuk memberikan format yang ditentukan kepada pengguna untuk diikuti. Informasi tambahan yang Anda sertakan akan ditambahkan ke deskripsi permintaan pull untuk diperbarui oleh pengguna yang mengirimkan.

Contoh template Permintaan Pull

3 baris pertama template harus mengikuti konvensi yang ditunjukkan dalam contoh berikut. Semua yang ada setelahnya adalah opsi dan akan membantu pengguna Anda membuat permintaan pull yang mengikuti konvensi Anda.

---
title: "[PR]: <Insert title>"
---
<!-- Thank you for your contribution! -->

<!-- Include if applicable: -->
Fixes: #nnn <!-- tracking issues that this PR will close -->
**Related**: _Relevant tracking issues, for context_
**Merge before/after**: _Dependent or prerequisite PRs_

**Description**
<!-- Describe your changes here. The more detail, the easier the review! -->

**User facing changes (remove if N/A)**
<!-- Describe any user facing changes this PR introduces. -->
<!-- "Before" and "After" sections work great - bonus points for screenshots! -->
<!-- Be sure all docs have been updated as well! -->

**Follow-up Work (remove if N/A)**
<!-- Mention any related follow up work to this PR. -->

Langkah berikutnya