Pular para conteúdo

Contributing Guide

We welcome contributions to our prompt engineering collection! This guide will help you understand how to contribute effectively.

How to Contribute

  1. Fork the Repository
  2. Fork the repository on GitHub

  3. Clone your fork locally

  4. Create a New Branch bash git checkout -b feature/new-prompt-category

  5. Add Your Prompts

  6. Follow the prompt template structure
  7. Place prompts in the appropriate category
  8. Create a new category if needed

Prompt Template Structure

# [Prompt Title]

## Context
[Explain when and why to use this prompt]

## Variables
- {variable1}: [Description]
- {variable2}: [Description]

## Prompt Template
[Your prompt template here]

## Example Usage
[Provide a concrete example]

## Best Practices
[List best practices and tips]

Guidelines

  1. Quality Standards
  2. Clear and concise writing
  3. Proper formatting and structure
  4. Comprehensive documentation

  5. Tested examples

  6. Naming Conventions

  7. Use descriptive names
  8. Follow existing patterns

  9. Keep it simple and clear

  10. Documentation

  11. Include all required sections
  12. Provide clear examples
  13. Explain variables thoroughly
  14. Add relevant context

Submission Process

  1. Create a Pull Request
  2. Push your changes to your fork
  3. Create a PR to the main repository

  4. Follow the PR template

  5. Code Review

  6. Address review comments
  7. Make requested changes

  8. Keep the discussion constructive

  9. Merge

  10. Your PR will be merged once approved
  11. Celebrate your contribution! 🎉

Need Help?

  • Check existing prompts for examples
  • Open an issue for questions
  • Join our community discussions

Thank you for contributing to making this collection better for everyone!