You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: .github/workflows/pr.yaml
+1-1
Original file line number
Diff line number
Diff line change
@@ -25,4 +25,4 @@ jobs:
25
25
- name: Set status
26
26
if: failure()
27
27
run: |
28
-
gh pr comment ${{ github.event.pull_request.number }} --body "❌ PR title does not match the required pattern. Please use the format: 'type: description' (e.g., 'feat: add new feature')."
28
+
gh pr comment ${{ github.event.pull_request.number }} --body "❌ PR title does not match the required pattern. Please use the format: 'type: description' (e.g., 'feat|fix|docs|style|refactor|test|chore: title')."
Copy file name to clipboardexpand all lines: docs/docs/community/contributing.md
+102
Original file line number
Diff line number
Diff line change
@@ -78,6 +78,108 @@ By internalizing the OODA Loop, you can quickly identify areas where you can mak
78
78
- Leverage AI assistants to help with tasks like code generation, document summarization, and content creation.
79
79
- Collaborate with other community members to divide and conquer larger initiatives.
80
80
81
+
---
82
+
83
+
## Contributing Guidelines
84
+
85
+
We value structured and clear contributions to ensure the project evolves efficiently. Below are the guidelines for submitting your contributions:
86
+
87
+
### Pull Request (PR) Title Format
88
+
89
+
Use the following format for PR titles to maintain consistency and clarity:
90
+
91
+
```
92
+
feat|fix|docs|style|refactor|test|chore: title
93
+
```
94
+
95
+
### Pull Request Description Template
96
+
97
+
When submitting a PR, use this template to ensure all relevant details are included:
98
+
99
+
```markdown
100
+
<!-- Use this template by filling in information and copy and pasting relevant items out of the html comments. -->
101
+
102
+
# Relates to:
103
+
104
+
<!-- LINK TO ISSUE OR TICKET -->
105
+
106
+
<!-- This risks section is to be filled out before final review and merge. -->
107
+
108
+
# Risks
109
+
110
+
<!--
111
+
Low, medium, large. List what kind of risks, and what could be affected.
112
+
-->
113
+
114
+
# Background
115
+
116
+
## What does this PR do?
117
+
118
+
## What kind of change is this?
119
+
120
+
<!--
121
+
Bug fixes (non-breaking change which fixes an issue)
122
+
Improvements (misc. changes to existing features)
123
+
Features (non-breaking change which adds functionality)
124
+
Updates (new versions of included code)
125
+
-->
126
+
127
+
<!-- This "Why" section is most relevant if there is no linked issue explaining why. If there is a related issue it might make sense to skip this why section. -->
128
+
<!--
129
+
## Why are we doing this? Any context or related work?
130
+
-->
131
+
132
+
# Documentation changes needed?
133
+
134
+
<!--
135
+
My changes do not require a change to the project documentation.
136
+
My changes require a change to the project documentation.
137
+
If a docs change is needed: I have updated the documentation accordingly.
138
+
-->
139
+
140
+
<!-- Please show how you tested the PR. This will really help if the PR needs to be retested, and probably help the PR get merged quicker. -->
141
+
142
+
# Testing
143
+
144
+
## Where should a reviewer start?
145
+
146
+
## Detailed testing steps
147
+
148
+
<!--
149
+
None, automated tests are fine.
150
+
-->
151
+
152
+
<!--
153
+
- As [anon/admin], go to [link]
154
+
- [do action]
155
+
- verify [result]
156
+
-->
157
+
158
+
<!-- If there is a UI change, please include before and after screenshots or videos. This will speed up PRs being merged. It is extra nice to annotate screenshots with arrows or boxes pointing out the differences. -->
159
+
<!--
160
+
## Screenshots
161
+
### Before
162
+
### After
163
+
-->
164
+
165
+
<!-- If there is anything about the deploy, please make a note. -->
166
+
<!--
167
+
# Deploy Notes
168
+
-->
169
+
170
+
<!-- Copy and paste command-line output. -->
171
+
<!--
172
+
## Database changes
173
+
-->
174
+
175
+
<!-- If there is something more than the automated steps, please specify deploy instructions. -->
176
+
<!--
177
+
## Deployment instructions
178
+
-->
179
+
```
180
+
181
+
---
182
+
81
183
## Recognition and Rewards
82
184
83
185
We believe in recognizing and rewarding contributors who go above and beyond to drive the project forward. Stand-out contributions may be eligible for:
0 commit comments