Skip to content

New Open SWE Request #12

@debianmaster

Description

@debianmaster

You're given a task to write a collection of rules, context and guidelines on the repository you're provided. Please gather context on the following categories, then write an AGENTS.md file in the root of the repository.

  • General Rules: These are general rules any developer/agent should follow when writing code. It should contain rules such as "When creating new XYZ functions, always first search in the XYZ/ directory to see if one exists, and if not, create it and place it in an existing or new file". Additionally, here is where you'd include context about scripts which are commonly executed, such as linter and formatter scripts.
  • Repository Structure: This section is where you'll include high level context about how the repository is laid out, any highly useful and not overly obvious information about how the directories/files are structured, different apps/packages/services inside the repository, etc. Do not include every last detail about the repository contents, only a high level technical overview on the repository structure.
  • Dependencies and Installation: This section should include high level context about how to install dependencies, where to install them, package managers, etc. Do not include overly verbose context in this section as most repositories typically have straightforward dependency management.
  • Testing Instructions: A general guide on testing in this repository. It should include context such as testing frameworks, roughly what types of modules should be tested, how to run tests, and any other context a developer wouldn't be able to infer by looking at test files on how to write & run tests. Do not include every last detail about testing in this section, only the most used/important context necessary to run tests.

Ensure each category is properly wrapped in opening and closing XML tags. The tags to use are as follows:
<general_rules>
</general_rules>
<repository_structure>
</repository_structure>
<dependencies_and_installation>
</dependencies_and_installation>
<testing_instructions>
</testing_instructions>

It is incredibly important that you ALWAYS wrap your sections in the opening and closing XML tags. Failure to do so will result in an invalid file and will not be accepted.

The file should not contain any other content besides those tags, and the rules/context/instructions they contain. Ensure your rules are thoughtful, concise and actually useful to a developer who's never contributed to the repository before. You can think of it as a more structured and directed CONTRIBUTING.md file.

With all of this in mind, please explore the repository and write this single AGENTS.md file with the rules/context/instructions gathered!

Agent Context { "tasks": [ { "id": "e5e5bcd3-98c4-4a98-bce0-c7849c5a9a86", "taskIndex": 0, "request": "[original issue]\n**New Open SWE Request**\nYou're given a task to write a collection of rules, context and guidelines on the repository you're provided. Please gather context on the following categories, then write an `AGENTS.md` file in the root of the repository.\n\n- **General Rules**: These are general rules any developer/agent should follow when writing code. It should contain rules such as \"When creating new XYZ functions, always first search in the XYZ/ directory to see if one exists, and if not, create it and place it in an existing or new file\". Additionally, here is where you'd include context about scripts which are commonly executed, such as linter and formatter scripts.\n- **Repository Structure**: This section is where you'll include high level context about how the repository is laid out, any highly useful and not overly obvious information about how the directories/files are structured, different apps/packages/services inside the repository, etc. Do not include every last detail about the repository contents, only a high level technical overview on the repository structure.\n- **Dependencies and Installation**: This section should include high level context about how to install dependencies, where to install them, package managers, etc. Do not include overly verbose context in this section as most repositories typically have straightforward dependency management. \n- **Testing Instructions**: A general guide on testing in this repository. It should include context such as testing frameworks, roughly what types of modules should be tested, how to run tests, and any other context a developer wouldn't be able to infer by looking at test files on how to write & run tests. Do not include every last detail about testing in this section, only the most used/important context necessary to run tests.\n\nEnsure each category is properly wrapped in opening and closing XML tags. The tags to use are as follows:\n\n\n\n\n\n\n\n\n\nIt is incredibly important that you ALWAYS wrap your sections in the opening and closing XML tags. Failure to do so will result in an invalid file and will not be accepted.\n\nThe file should not contain any other content besides those tags, and the rules/context/instructions they contain. Ensure your rules are thoughtful, concise and actually useful to a developer who's never contributed to the repository before. You can think of it as a more structured and directed `CONTRIBUTING.md` file.\n\nWith all of this in mind, please explore the repository and write this single `AGENTS.md` file with the rules/context/instructions gathered!", "title": "Create AGENTS.md file with microservices development guidelines and repository structure documentation", "createdAt": 1751839799044, "completed": true, "planRevisions": [ { "revisionIndex": 0, "plans": [ { "index": 0, "plan": "Create AGENTS.md file in the root directory with exactly 4 XML-wrapped sections containing comprehensive development guidelines for this polyglot microservices repository on OpenShift, including: section with deployment script usage (installscripts/ directory with numbered scripts 1-5), environment variable setup requirements (1.setVariable.sh), service directory structure checks, and OpenShift template usage; section describing the 4 main microservices (nodejs-users-api with MongoDB, python-email-api with MySQL, java-twitter-feed-api with Tomcat, php-ui frontend), installscripts/ deployment automation, and .openshift_template/ directory; section covering per-service dependency management (npm for NodeJS, pip for Python, Maven for Java, no package manager for PHP); section explaining the limited testing setup (only nodejs-users-api/test.js exists), REST API endpoint testing approach, and integration testing requirements with proper environment variable configuration", "completed": true } ], "createdAt": 1751839799044, "createdBy": "agent" } ], "activeRevisionIndex": 0, "completedAt": 1751839910145, "summary": "## Task Completion Summary\n\nI have successfully created the `AGENTS.md` file in the root directory with the four required XML-wrapped sections:\n\n**Changes Made:**\n- Created `AGENTS.md` with comprehensive development guidelines for the polyglot microservices repository\n- Added `` section covering deployment script usage (installscripts 1-5), environment variable setup via 1.setVariable.sh, and OpenShift template usage\n- Added `` section describing the 4 microservices (nodejs-users-api, python-email-api, java-twitter-feed-api, php-ui) and deployment automation\n- Added `` section covering npm, pip, Maven, and PHP dependency management\n- Added `` section explaining the limited testing setup and REST API testing approach\n\nThe file provides essential context for developers working with this OpenShift-based microservices architecture, including proper deployment order, service communication patterns, and testing strategies." } ], "activeTaskIndex": 0 }

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions