Sitelet https://github.com/untoldengine/UntoldEngine/blob/develop/.github/copilot-instructions.md
Skip to content

Latest commit

 

History

History
26 lines (23 loc) · 1.65 KB

File metadata and controls

26 lines (23 loc) · 1.65 KB

Copilot Code Review Instructions

When reviewing pull requests for this repository:

  • Focus on clarity, maintainability, and consistency with Swift naming conventions.
  • Look out for duplicate file names across modules (e.g., Core vs Editor) that could confuse contributors.
  • Pay special attention to unit tests:
    • Check that new functionality is covered by tests where it makes sense.
    • Flag missing or incomplete tests for critical systems (e.g., rendering, ECS, physics).
    • Suggest improvements for test readability, coverage, and clarity.
  • Suggest improvements for documentation and comments where the intent of code is not obvious.
  • Identify potential performance bottlenecks, especially in rendering or compute-heavy code.
  • Check for error handling: guard statements, meaningful fallback behavior, crash prevention.
  • Avoid being overly nitpicky — only raise issues that impact readability, maintainability, testability, or functionality.
  • Do not enforce style rules — SwiftFormat is already run automatically. Only highlight when style issues affect readability.
  • If something is unclear, ask for explanation rather than rejecting the PR.
  • Verify that all source files and Metal shader files include the proper copyright and license notice at the very top:
    // Copyright (C) Untold Engine Studios
    //
    // This Source Code Form is subject to the terms of the Mozilla Public
    // License, v. 2.0. If a copy of the MPL was not distributed with this
    // file, You can obtain one at https://mozilla.org/MPL/2.0/.

Final decision always rests with human maintainers; Copilot is here to provide helpful suggestions.