Skip to content

Commit 6a4c4c6

Browse files
committed
Simplify PR template based on vllm
1 parent c949cfd commit 6a4c4c6

File tree

1 file changed

+24
-57
lines changed

1 file changed

+24
-57
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 24 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,35 @@
1-
FILL IN THE PR DESCRIPTION HERE
1+
# PR Template for ChatFAQ
22

3-
FIX #xxxx (*link existing issues this PR will resolve*)
3+
Fixes # (issue)
44

5-
**BEFORE SUBMITTING, PLEASE READ THE CHECKLIST BELOW AND FILL IN THE DESCRIPTION ABOVE**
5+
## Description
66

7-
---
7+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
88

9-
<details>
10-
<!-- inside this <details> section, markdown rendering does not work, so we use raw html here. -->
11-
<summary><b> PR Checklist (Click to Expand) </b></summary>
9+
## Type of Change
1210

13-
<p>Thank you for your contribution to ChatFAQ! Before submitting the pull request, please ensure the PR meets the following criteria. This helps ChatFAQ maintain the code quality and improve the efficiency of the review process.</p>
11+
Please delete options that are not relevant.
1412

15-
<h3>PR branch</h3>
16-
Make sure that this PR targets the main branch.
13+
- [ ] Bugfix (non-breaking change which fixes an issue)
14+
- [ ] CI/Build (changes to our build system or CI configuration files and scripts)
15+
- [ ] Documentation (changes to the documentation)
16+
- [ ] Back (changes to the ChatFAQ Back)
17+
- [ ] Admin (changes to the ChatFAQ Admin)
18+
- [ ] Widget (changes to the ChatFAQ Widget)
19+
- [ ] CLI (changes to the ChatFAQ CLI)
20+
- [ ] chat-rag (changes to the chat-rag package)
21+
- [ ] Misc (other changes that don't fit into the above categories)
1722

23+
## Checklist
1824

19-
<h3>PR Title and Classification</h3>
20-
<p>Only specific types of PRs will be reviewed. The PR title is prefixed appropriately to indicate the type of change. Please use one of the following:</p>
21-
<ul>
22-
<li><code>[Bugfix]</code> for bug fixes.</li>
23-
<li><code>[CI/Build]</code> for build or continuous integration improvements.</li>
24-
<li><code>[Doc]</code> for documentation fixes and improvements.</li>
25-
<li><code>[Back]</code> For changes on the ChatFAQ Back </li>
26-
<li><code>[Admin]</code> For changes on the ChatFAQ Admin </li>
27-
<li><code>[Widget]</code> For changes on the ChatFAQ Widget </li>
28-
<li><code>[CLI]</code> For changes on the ChatFAQ CLI </li>
29-
<li><code>[Chat RAG]</code> For changes on the ChatFAQ Chat RAG </li>
30-
<li><code>[Misc]</code> for PRs that do not fit the above categories. Please use this sparingly.</li>
31-
</ul>
32-
<p><strong>Note:</strong> If the PR spans more than one category, please include all relevant prefixes.</p>
25+
Please ensure your pull request meets the following requirements:
3326

34-
<h3>Code Quality</h3>
35-
36-
<p>The PR need to meet the following code quality standards:</p>
37-
38-
<ul>
39-
<li>We adhere to <a href="https://code.with-madrid.com/en/latest/">WITH’s Coding Guidelines</a>.</li>
40-
<li><code>black</code> and <code>isort</code> to format your code.</li>
41-
<li>The code need to be well-documented to ensure future contributors can easily understand the code.</li>
42-
<li>Include sufficient tests to ensure the project to stay correct and robust. This includes both unit tests and integration tests.</li>
43-
<li>Please add documentation to <code>docs/source/</code> if the PR modifies the user-facing behaviors of ChatFAQ. It helps ChatFAQ user understand and utilize the new features or changes.</li>
44-
</ul>
45-
46-
<h3>Notes for Large Changes</h3>
47-
<p>Please keep the changes as concise as possible. For major architectural changes (>500 LOC excluding tests), we would expect a GitHub issue (RFC) discussing the technical design and justification. Otherwise, we will tag it with <code>rfc-required</code> and might not go through the PR.</p>
48-
49-
<h3>What to Expect for the Reviews</h3>
50-
51-
<p>The goal of the ChatFAQ team is to be a <i>transparent reviewing machine</i>. We would like to make the review process transparent and efficient and make sure no contributor feel confused or frustrated. However, the ChatFAQ team is small, so we need to prioritize some PRs over others. Here is what you can expect from the review process: </p>
52-
53-
<ul>
54-
<li> After the PR is submitted, the PR will be assigned to a reviewer. Every reviewer will pick up the PRs based on their expertise and availability.</li>
55-
<li> After the PR is assigned, the reviewer will provide status update every 2-3 days. If the PR is not reviewed within 7 days, please feel free to ping the reviewer or the ChatFAQ team.</li>
56-
<li> After the review, the reviewer will put an <code> action-required</code> label on the PR if there are changes required. The contributor should address the comments and ping the reviewer to re-review the PR.</li>
57-
<li> Please respond to all comments within a reasonable time frame. If a comment isn't clear or you disagree with a suggestion, feel free to ask for clarification or discuss the suggestion.
58-
</li>
59-
</ul>
60-
61-
<h3>Thank You</h3>
62-
63-
<p> Finally, thank you for taking the time to read these guidelines and for your interest in contributing to ChatFAQ. Your contributions make ChatFAQ a great tool for everyone! </p>
64-
65-
66-
</details>
27+
- [ ] I have read the [contributing guidelines](CONTRIBUTING.md).
28+
- [ ] My code follows the [WITH's Coding Guidelines](https://code.with-madrid.com/en/latest/). Mainly formatting using `black` and `isort`.
29+
- [ ] I have commented my code, particularly in hard-to-understand areas.
30+
- [ ] I have made corresponding changes to the documentation.
31+
- [ ] I have added tests that prove my fix is effective or that my feature works.
6732

33+
## Additional Notes
6834

35+
Please provide any additional information or context that may be helpful for the reviewers.

0 commit comments

Comments
 (0)