How to Contribute Content

The Prompt Library thrives on community contributions. This guide explains various ways to add your own prompts, rules, project configurations, or workflow states to the library.

Quick Submit

If you want to quickly submit new content, use one of the forms below. No need to fork or make a pull request!

Submit a Prompt Submit a Rule Submit a Project Config Submit a Workflow State

Step-by-Step Process

  1. Fork the repository

    Start by forking the Prompt Library repository to your own GitHub account.

  2. Clone your fork locally 
    git clone https://github.com/your-username/prompt_library.git
cd prompt_library
  3. Create a branch for your contribution 
    git checkout -b add-new-content
  4. Add your content

    Create a new Markdown file in the appropriate category folder:

    # Example: Adding a development prompt
touch development/prompts/your-prompt-name.md
  5. Submit a pull request

    Push your changes and create a pull request from your fork to the main repository.

    git add .
git commit -m "Add new prompt for [purpose]"
git push origin add-new-content

    Then go to GitHub and create a pull request from your branch.

File Structure Requirements

Each content file should include the following frontmatter:

---
title: "Your Content Title"
description: "Brief description of your content"
date: 2023-04-05
tags:
  - tag1
  - tag2
---

# Main Content Title

Your content goes here...

Cursor is an AI-powered code editor that can help you create content for the Prompt Library with built-in rules for formatting and structure.

Setting Up Cursor

  1. Install Cursor

    Download and install Cursor from their official website.

  2. Clone the repository 
    git clone https://github.com/your-username/prompt_library.git
  3. Open the project in Cursor

    Open the prompt_library folder in Cursor.

Using Cursor's AI Assistance

  1. Create a new file in the appropriate directory based on your content type and discipline.
  2. Leverage the prompt-library-requirements rule

    Cursor has built-in rules to help with content creation. You can ask the AI:

    "I want to create a new prompt for [your purpose]. Can you help me follow the prompt-library-requirements?"
  3. Review and refine the generated content with the AI's help.
  4. Submit your changes following the GitHub contribution workflow above.

If you have a content idea but don't want to create the files yourself, you can submit a content suggestion via GitHub Issues.

Submit a Prompt Submit a Rule Submit a Project Config Submit a Workflow State

Submitting a Content Suggestion

  1. Go to the Issues page of the repository.
  2. Create a new issue with the title beginning with "Content Suggestion:".
  3. Include the following information:
    • Content type (Prompt, Cursor Rule, Project Config, or Workflow State)
    • Discipline category (Development, Project Management, etc.)
    • Content title and description
    • Detailed content or a rough draft
    • Any reference materials or examples

What Happens Next

Maintainers will review your suggestion and may:

  • Create the content based on your suggestion
  • Request more information or clarification
  • Suggest modifications to fit the library's format
  • Invite you to contribute the content directly

You can now contribute external resources (guides, documentation, prompt lists, tools, etc.) to the library for any discipline.

How to Submit a Resource

  1. Use the Resource Submission Issue Template on GitHub.
  2. Fill out all required fields (title, description, URL, resource type, topics, discipline, etc.).
  3. Submit the issue. A maintainer will review and add it to the appropriate discipline's resources/ folder.

What Qualifies as a Resource?

  • External documentation or official guides
  • Curated prompt lists
  • Educational articles, videos, or tutorials
  • Useful tools or reference sites

Maintainer Workflow

  1. Review the submitted issue for completeness and relevance.
  2. Create a Markdown file in the appropriate resources/ folder using the provided metadata.
  3. Close the issue once the resource is added.

Required Metadata Fields

  • title: Clear, descriptive title
  • description: Brief summary (1-2 sentences)
  • date: Creation or last update date
  • tags: Relevant keywords (minimum 2)

Content Formatting Guidelines

  • Use Markdown syntax for formatting
  • Include clear section headings (H2, H3, etc.)
  • Use code blocks for examples with language specification
  • Keep line length reasonable (under 100 characters)
  • Use bullet points and numbered lists for clarity

Testing/Validation Steps

Before submitting your contribution:

  1. Verify all required metadata is present
  2. Check that your content renders correctly locally (run npm start to preview)
  3. Validate links and code examples
  4. Ensure your content follows the established style and formatting

Additional Resources