my-project-public

repository

loading code, commits, and activity

repositories

loading repo index

#1	# Contributing to AI Agents Library Agents
#2
#3	Thank you for contributing to the AI Agents Library Agent Marketplace! This guide will help you submit high-quality agents.
#4
#5	## Quick Start
#6
#7	1. Fork the repository
#8	2. Create your agent in `/src/`
#9	3. Test thoroughly
#10	4. Submit a Pull Request
#11
#12	## Submission Guidelines
#13
#14	### Agent Requirements
#15
#16	✅ Must Have:
#17
#18	- Unique identifier (no duplicates)
#19	- Clear, descriptive title
#20	- Concise description (160-200 characters)
#21	- Relevant emoji avatar
#22	- 3-8 appropriate tags
#23	- Well-structured system prompt
#24	- Valid JSON format
#25
#26	❌ Not Allowed:
#27
#28	- Copyrighted content
#29	- Malicious or harmful prompts
#30	- Personal/private information
#31	- Spam or low-effort submissions
#32	- Duplicate agents (check existing first)
#33
#34	### File Structure
#35
#36	```
#37	src/
#38	your-agent-name.json # Main agent file (English)
#39	your-agent-name.zh-CN.json # Optional: Chinese translation
#40	```
#41
#42	If you only provide English, our automated i18n workflow will translate to 18 languages.
#43
#44	### Agent Template
#45
#46	Create `/src/your-agent-name.json`:
#47
#48	```json
#49	{
#50	"author": "your-github-username",
#51	"config": {
#52	"systemRole": "You are [detailed system prompt]..."
#53	},
#54	"identifier": "your-agent-name",
#55	"meta": {
#56	"title": "Your Agent Title",
#57	"description": "Brief description of what your agent does",
#58	"avatar": "🤖",
#59	"tags": ["defi", "trading", "relevant", "keywords"]
#60	},
#61	"schemaVersion": 1
#62	}
#63	```
#64
#65	### Naming Conventions
#66
#67	Identifier (filename):
#68
#69	- Use lowercase
#70	- Use hyphens for spaces: `clawd-yield-optimizer`
#71	- No special characters except hyphens
#72	- Keep it descriptive but concise
#73
#74	Title (display name):
#75
#76	- Use Title Case
#77	- Can include spaces
#78	- Clear and professional
#79
#80	## Categories & Tags
#81
#82	### Primary Categories
#83
#84	- `defi` - DeFi protocols, yield, liquidity
#85	- `trading` - Market analysis, strategies
#86	- `security` - Audits, vulnerability analysis
#87	- `development` - Coding, smart contracts
#88	- `analytics` - Data analysis, metrics
#89	- `education` - Learning, tutorials
#90	- `research` - Protocol research, tokenomics
#91	- `portfolio` - Asset management
#92	- `nft` - NFT analytics, collections
#93
#94	### Specific Tags
#95
#96	- Protocol names: `uniswap`, `aave`, `clawd`
#97	- Technologies: `ethereum`, `layer2`, `solidity`
#98	- Functions: `yield-optimization`, `risk-assessment`
#99
#100	Use 3-8 tags total for optimal discoverability.
#101
#102	## Quality Standards
#103
#104	### System Prompts
#105
#106	Good prompts are:
#107
#108	- Clear: Specific role and capabilities
#109	- Structured: Organized sections (identity, guidelines, format)
#110	- Bounded: Define scope and limitations
#111	- Tested: Verified with real queries
#112
#113	See [Prompt Engineering Guide](./PROMPTS.md) for detailed tips.
#114
#115	### Testing Checklist
#116
#117	Before submitting, test with:
#118
#119	- [ ] Standard queries (happy path)
#120	- [ ] Edge cases (unusual requests)
#121	- [ ] Out-of-scope questions
#122	- [ ] Follow-up conversations
#123	- [ ] Error handling
#124
#125	### Code Quality
#126
#127	- [ ] Valid JSON (use a validator)
#128	- [ ] No trailing commas
#129	- [ ] Proper escaping of quotes
#130	- [ ] Consistent formatting (2-space indent)
#131
#132	## Pull Request Process
#133
#134	### 1. Prepare Your PR
#135
#136	```bash
#137	# Fork and clone
#138	git clone https://github.com/YOUR_USERNAME/ai-agents-library.git
#139	cd ai-agents-library
#140
#141	# Create branch
#142	git checkout -b add-your-agent-name
#143
#144	# Add your agent
#145	# Edit src/your-agent-name.json
#146
#147	# Commit
#148	git add src/your-agent-name.json
#149	git commit -m "feat: add Your Agent Name"
#150
#151	# Push
#152	git push origin add-your-agent-name
#153	```
#154
#155	### 2. PR Title Format
#156
#157	```
#158	feat: add [Agent Name]
#159	```
#160
#161	Examples:
#162
#163	- `feat: add DeFi Yield Optimizer`
#164	- `feat: add Smart Contract Security Auditor`
#165
#166	### 3. PR Description Template
#167
#168	```markdown
#169	## Agent Information
#170
#171	- Name: Your Agent Title
#172	- Category: Primary category
#173	- Tags: tag1, tag2, tag3
#174
#175	## Description
#176
#177	Brief explanation of what your agent does and why it's useful.
#178
#179	## Testing
#180
#181	- [x] Tested with standard queries
#182	- [x] Validated JSON
#183	- [x] Follows naming conventions
#184	- [x] No duplicate identifiers
#185
#186	## Additional Notes
#187
#188	Any special considerations or context.
#189	```
#190
#191	### 4. Review Process
#192
#193	We review PRs within 48-72 hours. Reviewers check:
#194
#195	- Originality and usefulness
#196	- Prompt quality and clarity
#197	- Technical accuracy
#198	- Community guidelines compliance
#199	- JSON validity
#200
#201	You may receive feedback requesting changes. Please address comments promptly.
#202
#203	## After Approval
#204
#205	Once merged:
#206
#207	1. Your agent is automatically translated to 18 languages
#208	2. It appears in the marketplace within 24 hours
#209	3. Users can immediately add it to their workspace
#210
#211	## Community Guidelines
#212
#213	### Be Respectful
#214
#215	- Welcome diverse perspectives
#216	- Provide constructive feedback
#217	- Help newcomers learn
#218
#219	### Be Professional
#220
#221	- Use appropriate language
#222	- Credit sources and inspiration
#223	- Respect intellectual property
#224
#225	### Be Collaborative
#226
#227	- Improve existing agents (with permission)
#228	- Share knowledge and tips
#229	- Help troubleshoot issues
#230
#231	## Agent Updates
#232
#233	To update an existing agent:
#234
#235	1. Create PR with changes to `src/your-agent-name.json`
#236	2. Title: `feat: update Your Agent Name`
#237	3. Explain what changed and why
#238
#239	## Need Help?
#240
#241	- 📖 Read the [Agent Creation Guide](./AGENT_GUIDE.md)
#242	- 🐛 Open an [Issue](https://github.com/nirholas/AI-Agents-Library/issues)
#243
#244	## Recognition
#245
#246	Top contributors:
#247
#248	- Featured on AI Agents Library homepage
#249	- Community recognition badges
#250	- Access to beta features
#251	- Direct feedback from users
#252
#253	---
#254
#255	Ready to contribute? Fork the repo and submit your first agent!
#256
#257
#258

z6Mkq5mY3JWtxoxUobWcfNHm7AkRubgSWEZTkBVqZXJviFZ5/my-project-public