Add Copilot instructions for repository conventions and patterns

[Copilot]

Configures GitHub Copilot with repository-specific context to improve code suggestion quality and consistency with established patterns.

Changes

Created .github/copilot-instructions.md documenting:

• Architecture: Header-only C++17 template library in buffers namespace with custom forward iterators
• Code standards: Modern C++17 idioms (perfect forwarding, constexpr if, conditional noexcept, SFINAE patterns)
• Naming conventions: snake_case types/functions, trailing underscore for members, PascalCase template params
• Build/test: CMake with GoogleTest via FetchContent, numerical test naming pattern
• Key constraints: O(1) operations, STL-compatible API, no dynamic allocation, fixed compile-time size
• Common patterns: SFINAE with std::enable_if<(Z), int>::type* = nullptr, modulo arithmetic for circular indexing, iterator comparison by count not index
• Special modes: Simulate_Android_ToolChain option for C++14 with -fno-exceptions

This provides Copilot with domain knowledge about the ring buffer implementation, helping it maintain type safety, exception guarantees, and performance characteristics when suggesting changes.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• gh.io
  • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

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)

• Fixes ✨ Set up Copilot instructions #7

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

---

Important

Adds .github/copilot-instructions.md to guide Copilot with project-specific guidelines for RingBufferCpp.

• Copilot Instructions:
  • Adds .github/copilot-instructions.md to guide Copilot with project-specific context.
  • Details architecture, code standards, naming conventions, build/test instructions, key features, and common patterns.
  • Specifies what not to do and special considerations for maintaining project integrity.

^{This description was created by for 5d93a0c. You can customize this summary. It will automatically update as commits are pushed.}

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[ellipsis-dev]

Important

Looks good to me! 👍

Reviewed everything up to 5d93a0c in 30 seconds. Click for details.

• Reviewed 115 lines of code in 1 files
• Skipped 0 files when reviewing.
• Skipped posting 4 draft comments. View those below.
• Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.

1. .github/copilot-instructions.md:1

• Draft comment:
  Overall, the instructions are clear and well-organized. Consider adding a brief note on when and how to update these guidelines to help maintain consistency over time.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50% None

2. .github/copilot-instructions.md:44

• Draft comment:
  The build instructions are clear. Consider specifying the minimum required CMake version (e.g., 3.14+) needed for FetchContent to avoid future confusion.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50% None

3. .github/copilot-instructions.md:90

• Draft comment:
  Good mention of the SFINAE pattern. It might help to include a minimal code snippet or a link to documentation for greater clarity.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50% None

4. .github/copilot-instructions.md:104

• Draft comment:
  The 'Special Considerations' section is thorough. For future-proofing, consider adding a note to review this section if project requirements or C++ standard support change.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50% None

Workflow ID: wflow_nBGynH4cr9HG6NIC

^{You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.}

[Copilot]

Pull request overview

This pull request adds GitHub Copilot instructions to help the AI assistant provide better code suggestions that align with the repository's established patterns and conventions.

Changes:

• Created .github/copilot-instructions.md documenting architecture, coding standards, build/test procedures, and project-specific patterns

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The actual codebase uses both traditional header guards (#ifndef RINGBUFFERTEST_RINGBUFFER_HPP / #define / #endif) AND #pragma once on line 11. The instruction here only mentions #pragma once, which could mislead Copilot into not using the traditional header guard pattern that's actually present in the code. Consider updating to reflect that both are used, or remove one from the actual code for consistency.

Suggested change

	- Use `#pragma once` for header guards
	- Use traditional header guards (`#ifndef` / `#define` / `#endif`) for headers; existing headers also include `#pragma once`, so follow this combined pattern when modifying them