Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding AI Agent Rules (Cursor + Copilot) #371

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

carvillanueva
Copy link

@carvillanueva carvillanueva commented Dec 22, 2024

Description

This PR introduces specific rules and instructions to fine-tune AI agents like Cursor and GitHub Copilot. Defining these rules (.cursorrules and .github/copilot-instructions.md) helps the agents provide more accurate and project-relevant assistance. However, it's crucial to remember that AI outputs may still include hallucinations or inaccuracies, so always review and validate the generated suggestions.

Related Issues

#265

Checklist

  • My code follows the code style of this project.
  • I have performed a self-review of my code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation, if necessary.
  • I have added tests that prove my fix is effective or my feature works.
  • New and existing tests pass locally with my changes.

Screenshots (if applicable)

Additional Notes

Copy link

vercel bot commented Dec 22, 2024

@carvillanueva is attempting to deploy a commit to the Hayden Bleasel Team on Vercel.

A member of the Team first needs to authorize it.

@carvillanueva
Copy link
Author

carvillanueva commented Dec 22, 2024

To Do:

  • Adding rules for copilot-instructions.md.✅
  • Update documentation under AI

@carvillanueva carvillanueva marked this pull request as draft December 22, 2024 19:09
@carvillanueva carvillanueva marked this pull request as ready for review January 2, 2025 21:10
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.

1 participant