Skip to content

Comments

docs: add agends.md file for agents instructions#186

Merged
jankapunkt merged 4 commits intomainfrom
feature/agents-md
Aug 26, 2025
Merged

docs: add agends.md file for agents instructions#186
jankapunkt merged 4 commits intomainfrom
feature/agents-md

Conversation

@jankapunkt
Copy link
Member

Coming from https://agents.md this PR adds basic structure to provide context for agents to properly work with OpenQDA in development.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a new documentation file specifically designed to provide AI agents with context and instructions for working with the OpenQDA development environment. The file establishes guidelines for Laravel backend, Vue.js frontend development, testing procedures, and commit conventions.

  • Creates comprehensive agent instructions document covering repository structure and development guidelines
  • Establishes technology-specific best practices for Laravel 11 and Vue.js 3 development
  • Documents testing, building, and commit procedures with specific commands

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

kadewe
kadewe previously approved these changes Aug 26, 2025
Copy link
Contributor

@kadewe kadewe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great. I mean it is even helpful for human programmers 🤓😜
One question – is it advisable to give even more CONTEXT to the agent? Like links to introductions to QDA-software?

@jankapunkt
Copy link
Member Author

Yes, I think we should craft another section that describes the domain. However we need to keep it concise enough to keep the context window small enough (think of your precious token...).

@jankapunkt jankapunkt merged commit a25a006 into main Aug 26, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants