Add agents.md file so we can have instructions for AI tools

XMLWordPrintableJSON

    • Type: Improvement
    • Resolution: Unresolved
    • Priority: Unknown
    • None
    • Affects Version/s: None
    • Component/s: None
    • 2
    • Not Needed
    • None
    • Hide

      Create a copy of the Kickoff Template with the issue key (NODE-XXX) in the filename and share a link to the new doc via this field.

      Show
      Create a copy of the Kickoff Template with the issue key (NODE-XXX) in the filename and share a link to the new doc via this field.
    • Hide

      1. What would you like to communicate to the user about this feature?
      2. Would you like the user to see examples of the syntax and/or executable code and its output?
      3. Which versions of the driver/connector does this apply to?

      Show
      1. What would you like to communicate to the user about this feature? 2. Would you like the user to see examples of the syntax and/or executable code and its output? 3. Which versions of the driver/connector does this apply to?
    • None
    • None
    • None
    • None
    • None
    • None

      Use Case

      As a... Node Driver developer
      I want... AI tools like Copilot to follow specific rules of our repo
      So that... we can configure what we don't want reviewed, or how to review our code

      User Experience

      • This is a developer-only change, our users shouldn't be impacted

      Dependencies

      • None

      Risks/Unknowns

      • Copilot may produce incorrect results if we mess up this file
      • If the file is too large/verbose, that may make Copilot more expensive and/or slower to use

      Acceptance Criteria

      Implementation Requirements

      • we have agents.md file in the repo and have verified that Copilot follows that logic
      • we can use NODE-7494 later to finalize this file and add others to other repos

      Testing Requirements

      • none

      Documentation Requirements

      • README should have instructions on how/when to update agents.md

      Follow Up Requirements

      • none

            Assignee:
            Sergey Zelenov
            Reporter:
            Pavel Safronov
            None
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: