Skip to content

Latest commit

 

History

History
109 lines (70 loc) · 6.04 KB

CONTRIBUTING.md

File metadata and controls

109 lines (70 loc) · 6.04 KB
Raw

Contributing to Prompt Engineering Repository

Welcome to the world's most comprehensive repository of Prompt Engineering techniques and implementations! 🌟 We're thrilled you're interested in contributing to this dynamic knowledge base. Your expertise and creativity can help us push the boundaries of prompt engineering technology.

Join Our Community

We have a vibrant Discord community where contributors can discuss ideas, ask questions, and collaborate on GenAI topics. Join us at:

DiamantAI Discord Server

Don't hesitate to introduce yourself and share your thoughts!

Ways to Contribute

We welcome contributions of all kinds! Here are some ways you can help:

  1. Add New Prompt Engineering Techniques: Create new notebooks showcasing novel prompt engineering implementations.
  2. Improve Existing Notebooks: Enhance, update, or expand our current tutorials.
  3. Fix Bugs: Help us squash bugs in existing code or explanations.
  4. Enhance Documentation: Improve clarity, add examples, or fix typos in our docs.
  5. Share Creative Ideas: Have an innovative idea for a new prompt engineering technique? We're all ears!
  6. Engage in Discussions: Participate in our Discord community to help shape the future of Gen AI.

Remember, no contribution is too small. Every improvement helps make this repository an even better resource for the community.

Reporting Issues

Found a problem or have a suggestion? Please create an issue on GitHub, providing as much detail as possible. You can also discuss issues in our Discord community.

Contributing Code or Content

  1. Fork and Branch: Fork the repository and create your branch from main.
  2. Make Your Changes: Implement your contribution, following our best practices.
  3. Test: Ensure your changes work as expected.
  4. Follow the Style: Adhere to the coding and documentation conventions used throughout the project.
  5. Commit: Make your git commits informative and concise.
  6. Stay Updated: The main branch is frequently updated. Before opening a pull request, make sure your code is up-to-date with the current main branch and has no conflicts.
  7. Push and Pull Request: Push to your fork and submit a pull request.
  8. Discuss: Use the Discord community to discuss your contribution if you need feedback or have questions.

Adding a New Prompt Engineering Technique

When adding a new prompt engineering technique to the repository, please follow these additional steps:

  1. Create your notebook in the all_prompt_engineering_techniques folder.
  2. Update the README.md file:
    • Add your new technique to the list of implementations in the README.
    • Place it in the appropriate category based on complexity and type.
    • Use the following format for the link: 
      ### [Number]. [Your Technique Name 🏷️](https://github.com/NirDiamant/Prompt_Engineering/blob/main/all_prompt_engineering_techniques/your_file_name.ipynb)
    • Replace [Number] with the appropriate number, [Your Technique Name] with your technique's name, and your_file_name.ipynb with the actual name of your notebook file.
    • Choose an appropriate emoji that represents your technique.
    • After inserting your new technique, make sure to update the numbers of all subsequent techniques to maintain the correct order.

For example:

1. [Intro-prompt-engineering-lesson 📝](hhttps://github.com/NirDiamant/Prompt_Engineering/blob/main/all_prompt_engineering_techniques/basic_prompt_construction.ipynb)
2. [Your New Technique 🆕](https://github.com/NirDiamant/Prompt_Engineering/blob/main/all_prompt_engineering_techniques/your_new_technique.ipynb)
3. [Next Technique 🔜](https://github.com/NirDiamant/Prompt_Engineering/blob/main/all_prompt_engineering_techniques/next_technique.ipynb)

Remember to increment the numbers of all techniques that come after your newly inserted implementation.

Notebook Structure

For new notebooks or significant additions to existing ones, please follow this structure:

  1. Title and Overview: Clear title and brief overview of the prompt engineering technique.

  2. Detailed Explanation: Cover motivation, key components, technique architecture, and conclusion.

  3. Implementation: Step-by-step implementation with clear comments and explanations.

  4. Usage Example: Demonstrate the technique with a practical example.

  5. Additional Considerations: Discuss limitations, potential improvements, or specific use cases.

  6. References: Include relevant citations or resources if you have.

Notebook Best Practices

To ensure consistency and readability across all notebooks:

  1. Code Cell Descriptions: Each code cell should be preceded by a markdown cell with a clear, concise title describing the cell's content or purpose.

  2. Consistent Formatting: Maintain consistent formatting throughout the notebook, including regular use of markdown headers, code comments, and proper indentation.

Code Quality and Readability

To ensure the highest quality and readability of our code:

  1. Write Clean Code: Follow best practices for clean, readable code.
  2. Use Comments: Add clear and concise comments to explain complex logic.
  3. Format Your Code: Use consistent formatting throughout your contribution.
  4. Language Model Review: After completing your code, consider passing it through a language model for additional formatting and readability improvements. This extra step can help make your code even more accessible and maintainable.

Documentation

Clear documentation is crucial. Whether you're improving existing docs or adding new ones, follow the same process: fork, change, test, and submit a pull request.

Final Notes

We're grateful for all our contributors and excited to see how you'll help expand the world's most comprehensive prompt engineering resource. Don't hesitate to ask questions in our Discord community if you're unsure about anything.

Let's harness our collective knowledge and creativity to push the boundaries of prompt engineering technology together!

Happy contributing! 🚀