Skip to content

Commit 714a380

Browse files
authored
Merge pull request #430 from monilpat/patch-1
docs: Update contributing.md to incorporate Contribution Guidelines
2 parents ea26d00 + f41ff92 commit 714a380

File tree

1 file changed

+105
-0
lines changed

1 file changed

+105
-0
lines changed

docs/docs/community/contributing.md

+105
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,109 @@ By internalizing the OODA Loop, you can quickly identify areas where you can mak
7878
- Leverage AI assistants to help with tasks like code generation, document summarization, and content creation.
7979
- Collaborate with other community members to divide and conquer larger initiatives.
8080

81+
82+
---
83+
84+
## Contributing Guidelines
85+
86+
We value structured and clear contributions to ensure the project evolves efficiently. Below are the guidelines for submitting your contributions:
87+
88+
### Pull Request (PR) Title Format
89+
90+
Use the following format for PR titles to maintain consistency and clarity:
91+
92+
```
93+
feat|fix|docs|style|refactor|test|chore: title
94+
```
95+
96+
### Pull Request Description Template
97+
98+
When submitting a PR, use this template to ensure all relevant details are included:
99+
100+
```markdown
101+
<!-- Use this template by filling in information and copy and pasting relevant items out of the html comments. -->
102+
103+
# Relates to:
104+
105+
<!-- LINK TO ISSUE OR TICKET -->
106+
107+
<!-- This risks section is to be filled out before final review and merge. -->
108+
109+
# Risks
110+
111+
<!--
112+
Low, medium, large. List what kind of risks, and what could be affected.
113+
-->
114+
115+
# Background
116+
117+
## What does this PR do?
118+
119+
## What kind of change is this?
120+
121+
<!--
122+
Bug fixes (non-breaking change which fixes an issue)
123+
Improvements (misc. changes to existing features)
124+
Features (non-breaking change which adds functionality)
125+
Updates (new versions of included code)
126+
-->
127+
128+
<!-- 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. -->
129+
<!--
130+
## Why are we doing this? Any context or related work?
131+
-->
132+
133+
# Documentation changes needed?
134+
135+
<!--
136+
My changes do not require a change to the project documentation.
137+
My changes require a change to the project documentation.
138+
If a docs change is needed: I have updated the documentation accordingly.
139+
-->
140+
141+
<!-- 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. -->
142+
143+
# Testing
144+
145+
## Where should a reviewer start?
146+
147+
## Detailed testing steps
148+
149+
<!--
150+
None, automated tests are fine.
151+
-->
152+
153+
<!--
154+
- As [anon/admin], go to [link]
155+
- [do action]
156+
- verify [result]
157+
-->
158+
159+
<!-- 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. -->
160+
<!--
161+
## Screenshots
162+
### Before
163+
### After
164+
-->
165+
166+
<!-- If there is anything about the deploy, please make a note. -->
167+
<!--
168+
# Deploy Notes
169+
-->
170+
171+
<!-- Copy and paste command-line output. -->
172+
<!--
173+
## Database changes
174+
-->
175+
176+
<!-- If there is something more than the automated steps, please specify deploy instructions. -->
177+
<!--
178+
## Deployment instructions
179+
-->
180+
```
181+
182+
---
183+
81184
## Recognition and Rewards
82185

83186
We believe in recognizing and rewarding contributors who go above and beyond to drive the project forward. Stand-out contributions may be eligible for:
@@ -96,3 +199,5 @@ Note: we're still finalizing details on the creator/dev fund that seeks to retro
96199
4. Share your ideas and initiatives with the community - we're excited to see what you'll build!
97200

98201
Lets push the boundaries of what's possible with autonomous AI agents. Welcome aboard!
202+
203+

0 commit comments

Comments
 (0)