Documentation - Copilot instructions for OCCT development#589
Merged
dpasukhi merged 3 commits intoOpen-Cascade-SAS:IRfrom Jul 6, 2025
Merged
Documentation - Copilot instructions for OCCT development#589dpasukhi merged 3 commits intoOpen-Cascade-SAS:IRfrom
dpasukhi merged 3 commits intoOpen-Cascade-SAS:IRfrom
Conversation
Added copilot-instructions.md Ignore other agents instruction for git history
There was a problem hiding this comment.
Pull Request Overview
This PR adds a comprehensive Copilot instructions document for OCCT C++17+ development, covering memory management, coding conventions, workflows, and build/test guidance.
- Introduces core directives for OCCT coding patterns.
- Details project structure, naming conventions, and modern C++ best practices.
- Provides step-by-step workflows for adding classes, tests, and building.
Comments suppressed due to low confidence (2)
.github/copilot-instructions.md:1
- Consider adding a table of contents at the top of this extensive document to help readers quickly navigate between sections.
# OCCT Copilot Instructions
.github/copilot-instructions.md:193
- [nitpick] For consistency, you might add the Windows equivalent for this quick build step (e.g., using
md build && cd build) alongside the Unix command.
mkdir -p build && cd build
Comment on lines
+106
to
+111
| - `auto` | ||
| - Range-based `for` loops | ||
| - Structured bindings: `for (const auto& [key, value] : aMap)` | ||
| - `std::optional` for optional return values where appropriate. | ||
| - `if constexpr` for compile-time conditions. | ||
|
|
There was a problem hiding this comment.
[nitpick] The list of modern C++ features is long; consider grouping related items under subheadings or turning this into a two-column table to improve scanability.
Suggested change
| - `auto` | |
| - Range-based `for` loops | |
| - Structured bindings: `for (const auto& [key, value] : aMap)` | |
| - `std::optional` for optional return values where appropriate. | |
| - `if constexpr` for compile-time conditions. | |
| | Feature | Description/Example | | |
| | ------------------------ | ------------------------------------------------------- | | |
| | `auto` | Simplifies type declarations. | | |
| | Range-based `for` loops | Cleaner iteration over containers. | | |
| | Structured bindings | `for (const auto& [key, value] : aMap)` for maps, etc. | | |
| | `std::optional` | Use for optional return values where appropriate. | | |
| | `if constexpr` | Enables compile-time conditions. | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added copilot-instructions.md
Ignore other agents instruction for git history