CONTRIBUTING.md

Contributing to teaql-agent-kit

First off, thank you for considering contributing to teaql-agent-kit!

Since this repository primarily consists of documentation, agent prompts, and guidelines rather than executable software, the contribution process is quite straightforward.

Where do I go from here?

If you've noticed a typo, an outdated prompt, or have an idea for a new agent playbook, make sure to check our Issues to see if someone else has already reported or proposed it. If not, go ahead and create one!

Submitting a Pull Request

If you want to contribute updates to the documentation or prompts:

1. Fork the project.
2. Create your feature branch (git checkout -b feature/new-playbook).
3. Make your changes. Please ensure that markdown files are properly formatted.
4. Commit your changes (git commit -am 'Add a new playbook for entity creation').
5. Push to the branch (git push origin feature/new-playbook).
6. Create a new Pull Request against our main branch.

Documentation Guidelines

• Use clear and concise English.
• Use standard Markdown formatting.
• If you are adding a new playbook, please follow the structure of existing playbooks in the playbooks/ directory.