Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (35 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

45 lines (35 loc) · 1.8 KB

Contributing to The Ultimate Prompt Engineering Guide

First off, thank you for considering contributing! This project is made possible by the community, and we appreciate all contributions, from fixing a typo to adding a new tutorial.

How to Contribute

We welcome contributions in various forms:

  • Content: Add new sections to the guide, create new tutorials, or expand on existing content.
  • Prompts: Add new prompts to our library, or improve existing ones.
  • Code: Contribute new code examples, or improve existing ones.
  • Corrections: Fix typos, grammatical errors, or factual inaccuracies.
  • Feedback: Provide feedback on the guide, tutorials, or the repository in general.

Getting Started

  1. Fork the repository: Click the "Fork" button at the top right of this page to create your own copy of this repository.
  2. Clone your fork: 
    git clone https://github.com/your-username/your-repo-name.git
  3. Create a new branch: 
    git checkout -b your-branch-name
  4. Make your changes: Make your changes to the files.
  5. Commit your changes: 
    git commit -m "Your commit message"
  6. Push your changes: 
    git push origin your-branch-name
  7. Create a pull request: Open a pull request from your fork to this repository.

Style Guide

  • Content: Write in clear, concise, and professional English. Use Markdown for formatting.
  • Code: Follow the existing code style. Add comments to your code where necessary.
  • Prompts: Provide a clear title and description for each prompt. Include the prompt itself and an example of the expected output.

Questions?

If you have any questions, feel free to open an issue or join our Discord community (link coming soon!).