Skip to content

Conversation

@saratpoluri
Copy link
Contributor

📝 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:

  • 🐞 Bug fix – Non-breaking change which fixes an issue
  • 🚀 New feature – Non-breaking change which adds functionality
  • 🔨 Refactor – Non-breaking change which refactors the code base
  • 💥 Breaking change – Changes that break existing functionality
  • 📚 Documentation update
  • 🔒 Security update
  • 🧪 Tests
  • 🚂 CI

🧪 Testing Scenarios

Describe how the changes were tested and how reviewers can test them too:

  • ✅ Tested manually
  • 🤖 Ran automated end-to-end tests

✅ Checklist

Before submitting the PR, ensure the following:

  • 🔍 PR title is clear and descriptive
  • 📝 For internal contributors: If applicable, include the JIRA ticket number (e.g., ITEP-123456) in the PR title. Do not include full URLs
  • 💬 I have commented my code, especially in hard-to-understand areas
  • 📄 I have made corresponding changes to the documentation
  • ✅ I have added tests that prove my fix is effective or my feature works

@saratpoluri saratpoluri changed the title Introduce copilot instructions file for the SceneScape repo ITEP-83086: Introduce copilot instructions file for the SceneScape repo Jan 6, 2026
@saratpoluri saratpoluri requested a review from Copilot January 6, 2026 20:23
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 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.md file 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-format file

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.

@saratpoluri saratpoluri changed the title ITEP-83086: Introduce copilot instructions file for the SceneScape repo ITEP-83086: Introduce copilot instructions to SceneScape Jan 6, 2026
@saratpoluri saratpoluri force-pushed the tools/copilot-instructions branch 2 times, most recently from 3c154be to ef09f03 Compare January 10, 2026 07:10
@tdorauintc
Copy link
Contributor

Please provide PR summary


## Documentation Locations by Component

- **Service Overview**: `<service>/docs/user-guide/overview.md` - Feature descriptions, API endpoints, usage examples
Copy link
Contributor

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.

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.

5 participants