Skip to content

Latest commit

 

History

History
77 lines (54 loc) · 2.06 KB

File metadata and controls

77 lines (54 loc) · 2.06 KB

Contributing to Story Splitter

Thanks for your interest in improving story breakdown for Product Owners!

How to Contribute

1. Suggest a New Prompt (Idea)

Have a problem that needs a prompt solution? File an issue first.

Process:

  1. Go to Issues
  2. Select "Prompt Idea" template
  3. Describe your problem and how often you face it
  4. If it's recurring, we'll create a prompt

Why issue first?

  • ✅ Focus on recurring problems (not one-time issues)
  • ✅ Avoids duplicate prompts
  • ✅ Others can suggest existing solutions

What happens after:

  • Recurring problem → We create the prompt
  • One-time issue → We explain why no prompt needed
  • Duplicate → We point you to existing prompt

2. Improve Existing Prompts

Found a better way to phrase a prompt?

  1. Fork the repository
  2. Edit the prompt file (prompts/*.md)
  3. Test it with ChatGPT/Claude
  4. Submit Pull Request with before/after example

PR Requirements:

  • Show example output (before and after)
  • Explain why your version is better
  • Keep prompt under 500 words

3. Add Real Examples

Used a prompt successfully? Share your story!

  1. Fork the repository
  2. Add to examples/ directory
  3. Use before-bad-story.md format
  4. Submit Pull Request

What makes a good example:

  • Real project (anonymize company details)
  • Shows actual impact (time saved, surprises avoided)
  • Before/after comparison
  • 200-300 words max

4. Fix Bugs or Typos

Small fixes welcome via Pull Request directly. No issue needed.

What We DON'T Accept

  • ❌ Prompts for one-time problems (file issue first to discuss frequency)
  • ❌ Overly complex prompts (> 500 words)
  • ❌ Prompts for non-Product Owner audiences
  • ❌ Time-to-points mappings (story points ≠ hours)
  • ❌ Tool-specific instructions (keep it generic)
  • ❌ Agile theory debates (link to official sources instead)

Code of Conduct

  • Be respectful and constructive
  • Focus on problems, not people
  • Help others learn

Questions?

Open a Discussion or file an Issue.