Skip to content

contributing.md

Latest commit

 

History

History
56 lines (35 loc) · 2.13 KB

contributing.md

File metadata and controls

56 lines (35 loc) · 2.13 KB

Contributing to Engineering Prompts

Thank you for considering contributing to Engineering Prompts! We welcome contributions from everyone, and there are a few guidelines to make the process smooth and easy.

How to Contribute

  1. Fork the Repository: Start by forking the repository to your GitHub account and cloning it to your local machine.

  2. Create a New Branch: Create a new branch for your contribution, such as feature/your-feature-name.

  3. Add Your Prompt Chain: Navigate to the appropriate section in README.md based on the domain your prompt belongs to. If your prompt doesn't fit into any of the existing sections, feel free to create a new one under the corresponding category.

  4. Update the README: Provide a clear description for your prompt chain. Use the format:

    ### **{Domain Name}**

- **{Use Case Name}**  
  "{Prompt Chain}"

  5. Test Your Changes: Ensure your prompt is correctly formatted and works as expected.

  6. Submit a Pull Request: After making your changes, push them to your fork and create a pull request. Be sure to include a description of your changes and why you think it adds value to the repository.

Guidelines

  • Be Clear: Ensure the prompt chain is easy to follow and provides clear context.
  • Be Concise: Keep the prompts concise and to the point, avoiding unnecessary fluff.
  • Be Descriptive: Provide enough information so someone unfamiliar with the task can understand and use the prompt effectively.

Adding a New Use Case

If you're adding a completely new use case that doesn't fit into the existing categories, follow these steps:

  1. Find the right domain If it fits into an existing category, place it under the right domain section in README.md.

  2. Create a new section If it's a completely new use case and domain, add a new section at the bottom of the README.md.

Thank You!

We truly appreciate your contributions! By helping us expand and improve this collection of prompts, you’re making it easier for developers to work more efficiently and with less effort.

Happy Prompting! 🚀