Update GitHub templates #201
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add explanation to each section - Add related issue section - Add a checklist to ensure code quality
- Adhere to markdownlint rules - Update label names - Add explanation to each section - Remove unused section
rileychh
added
priority: low
scope: documentation
ntut-xuan
reviewed
Sep 9, 2023
ntut-xuan
reviewed
Oct 21, 2023
There was a problem hiding this comment.
針對於 PR 的部分，我認為可以用以下的框架來描述 PR 的部分
- Related Issue
- Description (To describe how the PR work to solve the issue)
- Implementation (What things the author do)
- How to Review & Manual Test (How to review the PR and the stories to test the PR)
- Note (Optional)
舉個例子：
Description
Related Issue: #999
這個 PR 主要處理了羊駝爆發的問題，我們透過適當的函數調整來控制羊駝的產生數量，並使羊駝的數量不會快速增長。
Implementation
- 對於函數進行適當的調整，來控制羊駝的產生數量
- 對於資料庫的 Schema 進行修改（附上 Schema 的 Patch Script）
How to Review & Manual Test
- 測試羊駝在啟動時所產生的數量不會有大爆發的趨勢。
- 長時間測試羊駝的產生數量是否趨近於平穩。
Note
Revise the Pull Request template based on this comment: #201 (review)
…ter into update-github-templates
|
沒問題，我在 a633db0 根據你的範例更新 PR template 了。 |
ntut-xuan
requested changes
Oct 23, 2023
Add checkboxes to the `Implementation` and `Testing Instructions` sections of the GitHub Pull Request template.
ntut-xuan
approved these changes
Oct 23, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the pull request template and both the bug and feature request issue templates. The updated version improves guidance and is more suitable to our project.
Related to #192.
How to Verify?
This is not testable until merged. However, one can create a new repository and apply these templates and try them out.
Screenshots/GIF/Test Results (Optional)
None.