[maintenance] Add a PR template - #1121
Conversation
WalkthroughA new pull request template file was introduced to standardize and guide contributors on how to format their pull requests. The template includes instructions for titling, labeling, drafting, and composing release notes. No code or public entities were modified; only documentation was updated. Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
.github/PULL_REQUEST_TEMPLATE.md (2)
5-8: Fix typo & minor grammar
hesistate→hesitateAlso consider dropping the trailing comma after
[docs]to keep the list visually consistent.- - Don't hesistate to ask for opinion and review in the community chats, even if it's still a draft. + - Don't hesitate to ask for opinions and reviews in the community chats, even if it's still a draft.
2-6: Tighten wording on component labelsThe first bullet instructs: “Start the PR title with the [label] of Cozystack component.”
It may help newcomers if you explicitly show an example line:Example: `[platform] Add HAProxy health-check for API server`That small addition reduces ambiguity and aligns with the following bullet lists.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/PULL_REQUEST_TEMPLATE.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Build
| ```release-note | ||
| [] | ||
| ``` No newline at end of file |
There was a problem hiding this comment.
Placeholder [] breaks standard release-note tooling
Most changelog generators (including the Kubernetes-style tool referenced in line 19) expect either a free-form note or the literal word NONE.
Keeping [] causes the block to be parsed as an empty list item and can fail the release-note check in CI.
-```release-note
-[]
-```
+```release-note
+NONE
+```🤖 Prompt for AI Agents
In .github/PULL_REQUEST_TEMPLATE.md around lines 22 to 24, the placeholder `[]`
inside the release-note block breaks standard release-note tooling by being
interpreted as an empty list item. Replace the `[]` placeholder with the literal
word `NONE` inside the triple backticks to ensure compatibility with changelog
generators and pass the release-note check in CI.
Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
4c344c4 to
72f40f3
Compare
What this PR does
Adds a PR template that will be used for all new pull requests.
It promotes some good practices and has a designated space for a release note that we can later compile to form a changelog.
Release note
Summary by CodeRabbit