diff --git a/docs/docs/community/contributing.md b/docs/docs/community/contributing.md index bfcb0f6222..589c0c47bc 100644 --- a/docs/docs/community/contributing.md +++ b/docs/docs/community/contributing.md @@ -78,6 +78,109 @@ By internalizing the OODA Loop, you can quickly identify areas where you can mak - Leverage AI assistants to help with tasks like code generation, document summarization, and content creation. - Collaborate with other community members to divide and conquer larger initiatives. + +--- + +## Contributing Guidelines + +We value structured and clear contributions to ensure the project evolves efficiently. Below are the guidelines for submitting your contributions: + +### Pull Request (PR) Title Format + +Use the following format for PR titles to maintain consistency and clarity: + +``` +feat|fix|docs|style|refactor|test|chore: title +``` + +### Pull Request Description Template + +When submitting a PR, use this template to ensure all relevant details are included: + +```markdown + + +# Relates to: + + + + + +# Risks + + + +# Background + +## What does this PR do? + +## What kind of change is this? + + + + + + +# Documentation changes needed? + + + + + +# Testing + +## Where should a reviewer start? + +## Detailed testing steps + + + + + + + + + + + + + + + + +``` + +--- + ## Recognition and Rewards 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 4. Share your ideas and initiatives with the community - we're excited to see what you'll build! Lets push the boundaries of what's possible with autonomous AI agents. Welcome aboard! + +