mirror of
https://github.com/fauxpilot/fauxpilot.git
synced 2025-03-12 04:36:10 -07:00
2d9367ae45
This commit is to improve PR template (e.g., summary, goal, description, reproduction, and so on) that can be submitted by contributers to evolve the FauxPilot software. **Changelog** * Version 2 - Applied comments of reviewer(s) - Updated the sections of a PR writing guide for readability. * Version 1 - Added Pull Request template Signed-off-by: Geunsik Lim <leemgs@gmail.com> Signed-off-by: Geunsik Lim <geunsik.lim@samsung.com>
1.0 KiB
1.0 KiB
# [Template] PR Description
In general, the github system duplicates your commit message automatically for your convenience.
After composing your own PR description using this template, please remove any unneeded portions.
bash ## 1. General Description The commit title must begin with one of the eleven given options. Build, chore, CI, documentation, task, fix, performance, refactor, revert, style, and test are some examples. or more details, please see [HERE](https://www.conventionalcommits.org/en/v1.0.0/). Summarize changes in no more than 50 characters ASAP for readability and maintenance. ## 2. Changes proposed in this PR: - Bulleted lists are also acceptable. - Typically, a hyphen or asterisk before the bullet, followed by a single space. Resolves: #{GitHub-Issue-Number} See also: #{GitHub-Issue-Number} ## 3. How to evaluate: 1. Describe how to evaluate such that it may be reproduced by the reviewer (s). 2. Self assessment:** - Build test: [ ]Passed [ ]Failed [*]Skipped - Run test: [ ]Passed [ ]Failed [* ]Skipped