Skip to content

Enhance Copilot instructions with project context and best practices#17

Draft
3dJan with Copilot wants to merge 3 commits into
mainfrom
copilot/set-up-copilot-instructions
Draft

Enhance Copilot instructions with project context and best practices#17
3dJan with Copilot wants to merge 3 commits into
mainfrom
copilot/set-up-copilot-instructions

Conversation

Copilot AI commented Dec 26, 2025

Copy link
Copy Markdown

The repository lacked comprehensive Copilot instructions to guide code generation and reviews effectively. Enhanced .github/copilot-instructions.md to follow GitHub's best practices for custom instructions.

Added Context Sections

  • Project Overview: Describes Gladius as a volumetric 3MF playground with CSG interface, rendering engine, and multi-language API bindings
  • Tech Stack: Documents C++11, CMake, vcpkg, OpenGL/OpenCL dependencies with categorized library list
  • Project Structure: Maps directory layout (src/, library/, tests/, etc.)
  • Build Instructions: Platform-specific commands for Windows/Linux with prerequisites and environment variables

Added Code Examples

Concrete C++ patterns for project conventions:

// Naming: PascalCase classes, lowerCamelCase functions, m_ private members
class MeshRenderer {
private:
    int m_vertexCount;  // m_ prefix for private
public:
    void renderMesh();  // lowerCamelCase, verb prefix
    bool isVisible() const;  // is prefix for booleans
};

// East-side const preference
int const* ptr;  // Preferred over const int*

// Smart pointers over raw pointers
std::unique_ptr<Mesh> createMesh() {
    return std::make_unique<Mesh>();
}

Preserved Existing Guidelines

All original C++ guidelines remain: Allman braces, 4-space indents, GTest conventions, Doxygen comments, and test naming patterns (UnitOfWork_StateUnderTest_ExpectedBehavior).

File size: 223 lines (well under 1000 line recommendation).

Original prompt

This section details on the original issue you should resolve

<issue_title>✨ Set up Copilot instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI self-assigned this Dec 26, 2025
Copilot AI and others added 2 commits December 26, 2025 07:18
…d code examples

Co-authored-by: 3dJan <56254096+3dJan@users.noreply.github.com>
Co-authored-by: 3dJan <56254096+3dJan@users.noreply.github.com>
Copilot AI changed the title [WIP] Set up Copilot instructions for the repository Enhance Copilot instructions with project context and best practices Dec 26, 2025
Copilot AI requested a review from 3dJan December 26, 2025 07:19
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.

✨ Set up Copilot instructions

2 participants