Contributing Guidelines#

Thank you for your interest in contributing to AnnAI-chan! We welcome high-quality prompt submissions from the community.

How to Submit a Prompt#

1. Fork the Repository

   • Fork the AnnAI-chan repository
   • Clone your fork locally

2. Create Your Prompt File

   • Copy the template from /docs/prompts/template.mdx
   • Place it in the appropriate category folder
   • Name it descriptively (e.g., email-newsletter-writer.mdx)

3. Fill Out the Template

   • Complete all required frontmatter fields
   • Write clear, detailed instructions
   • Include at least one complete example
   • Add helpful tips and variations

4. Submit a Pull Request

   • Commit your changes with a descriptive message
   • Push to your fork
   • Open a pull request with:
     • Clear title describing the prompt
     • Brief description of use cases
     • Any relevant context

Quality Standards#

Required Elements#

• ✅ Complete frontmatter metadata
• ✅ Clear, actionable prompt template
• ✅ Variable descriptions
• ✅ At least one usage example
• ✅ Sample output (when applicable)
• ✅ 3-5 usage tips

Best Practices#

• Be Specific: Vague prompts produce inconsistent results
• Include Context: Explain when and why to use the prompt
• Test Thoroughly: Verify your prompt works across different models
• Keep it Focused: One prompt should solve one specific problem
• Language: Use clear, professional language

Frontmatter Fields#

1---
2title: 'Descriptive Title' # Required
3description: 'Brief description' # Required (max 160 chars)
4author: 'Your Name' # Required
5dateCreated: 'YYYY-MM-DD' # Required
6model: ['gpt-4', 'claude-3'] # Required (at least one)
7tags: ['tag1', 'tag2'] # Required (2-5 tags)
8category: 'category-name' # Required
9difficulty: 'beginner' # Required: beginner/intermediate/advanced
10language: ['en'] # Required
11version: '1.0' # Required
12---

Categories#

Place your prompt in one of these categories:

• content-creation - Writing, marketing, SEO
• programming - Code generation, debugging, reviews
• analysis - Data analysis, research, insights
• creative - Stories, art, brainstorming
• productivity - Planning, organization, efficiency
• education - Teaching, learning, explanations

Review Process#

1. Automated Checks

   • Frontmatter validation
   • Markdown formatting
   • File naming conventions

2. Manual Review

   • Quality and usefulness
   • Accuracy of metadata
   • Appropriate categorization
   • No harmful or inappropriate content

3. Feedback

   • We'll provide constructive feedback
   • You may be asked to make revisions
   • Once approved, your prompt will be merged

Code of Conduct#

• Be respectful and professional
• No offensive, harmful, or illegal content
• No plagiarism - only submit original work
• Give credit where appropriate
• Help maintain a positive community

Recognition#

Contributors will be:

• Listed in the prompt's author field
• Mentioned in release notes
• Added to our contributors page

Questions?#

• Open an issue for clarification
• Join our Discord community
• Email: contribute@annaichan.org

Thank you for helping make AnnAI-chan better!