nathan/frankgpt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
frankgpt/CONTRIBUTIONS.md
nathan f596f41a01 docs(structure): split README into focused documentation files 
- Extract troubleshooting guide to TROUBLESHOOTING.md
- Move usage examples to USAGE_EXAMPLES.md for better discoverability
- Add custom specialty creation guide to CONTRIBUTIONS.md
- Create semantic commit message generator prompt in prompts/
- Streamline README.md by removing 200+ lines of content now in dedicated files
- Improve documentation navigation with clearer separation of concerns
2026-04-19 16:50:58 -04:00

1.4 KiB
Raw Blame History

🤝 Contributing

Want to contribute a specialty or improve existing modules?

  1. For new specialties: Use specialty.TEMPLATE.instructions.md as your starting point
  2. For improvements: Ensure changes maintain v6 compatibility
  3. For bug fixes: Update version metadata if behavior changes
  4. Share: Custom specialties can be shared as standalone files

Principles:

  • Maintain portability (no environment coupling)
  • Use relative paths
  • Document in frontmatter
  • Include examples in workflows
  • Test with Frank.core independently

🎨 Creating Custom Specialties

Want to add your own domain expertise? Use the template:

  1. Copy the template:

    cp v6/specialties/specialty.TEMPLATE.instructions.md v6/specialties/specialty.legal.instructions.md

  2. Customize sections:

    • Replace placeholder text with your domain
    • Define 2-5 expert personas
    • Create 3-7 slash commands
    • Document 2-5 key workflows
    • Reference relevant skills

  3. Test integration:

    Ensure your specialty works with Frank.core by loading it in a test environment:

    Load: v6/Frank.core.agent.md + v6/specialties/specialty.legal.instructions.md

  4. Share (optional):

    Your custom specialty can be shared with others - just distribute the file!

See: specialty.TEMPLATE.instructions.md for detailed guidance