-
Notifications
You must be signed in to change notification settings - Fork 34
ITEP-83086: Introduce copilot instructions to SceneScape #842
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this 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 introduces comprehensive AI agent instructions for the SceneScape repository, providing structured guidance across multiple development areas including testing, shell scripting, Python, Makefile conventions, and JavaScript standards.
Key Changes:
- Added a centralized
.github/copilot-instructions.mdfile that serves as the main entry point for AI agents working with the SceneScape codebase - Created detailed language-specific instruction files for Python, JavaScript, Shell, and Makefile development
- Added comprehensive testing guide covering unit, functional, integration, UI, and smoke tests
- Added a minor formatting change to
.clang-formatfile
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
.github/copilot-instructions.md |
Main entry point providing architecture overview, build patterns, and quick reference for AI agents |
.github/instructions/testing.md |
Comprehensive testing guide with examples for unit, functional, integration, UI, and smoke tests |
.github/instructions/python.md |
Python coding standards including naming conventions, Django patterns, and common anti-patterns |
.github/instructions/shell.md |
Shell scripting standards covering best practices, error handling, and SceneScape-specific patterns |
.github/instructions/makefile.md |
Makefile conventions including organization, variables, Docker integration, and testing targets |
.github/instructions/javascript.md |
JavaScript standards for frontend development including jQuery usage, AJAX patterns, and map provider integration |
controller/src/robot_vision/.clang-format |
Added blank line at end of file for formatting consistency |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
3c154be to
ef09f03
Compare
|
Please provide PR summary |
|
|
||
| ## Documentation Locations by Component | ||
|
|
||
| - **Service Overview**: `<service>/docs/user-guide/overview.md` - Feature descriptions, API endpoints, usage examples |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggest using the index.md file to provide the overview. The Docs Team is planning on removing the overview.md article entirely and move all its content to index.md (the current structure with toc.rst and overview.md is a weird artefact from the past build setup).
What is more, our suggestion is to combine documents for all compponents in the repo under the main "Docs" folder (@swpng is working on a proposition PR right now). Once the change is approved, we will adjust this AI Agent instruction to reflect the new directory structure.
📝 Description
Provide a clear summary of the changes and the context behind them. Describe what was changed, why it was needed, and how the changes address the issue or add value.
✨ Type of Change
Select the type of change your PR introduces:
🧪 Testing Scenarios
Describe how the changes were tested and how reviewers can test them too:
✅ Checklist
Before submitting the PR, ensure the following: