Skip to content

Add GitHub Copilot instructions for Sinclair#116

Merged
darthjee merged 2 commits intomasterfrom
copilot/add-copilot-instructions
Mar 3, 2026
Merged

Add GitHub Copilot instructions for Sinclair#116
darthjee merged 2 commits intomasterfrom
copilot/add-copilot-instructions

Conversation

Copy link
Contributor

Copilot AI commented Mar 3, 2026

Adds .github/copilot-instructions.md so Copilot-generated code, comments, and documentation align with this repo's conventions.

What's included

  • Project purpose — describes Sinclair as a foundation gem providing base classes/modules for building other gems, with a summary of all major components
  • Dev workflow — Docker + docker-compose; make dev drops into the container shell
  • CI tooling — rspec, rubocop, yardstick (rake verify_measurements), YARD; sourced from .circleci/config.yml
  • Testing guidelines — ≥1 spec per source file; exempt files listed in config/check_specs.yml; avoid mocks; one expectation per it block
  • Code style — Clean Code + Sandi Metz rules: small single-responsibility classes, short methods, respect the Law of Demeter, YARD doc-comments on all public API
  • Language — explicit English-only requirement for all PRs, code, comments, and docs
Original prompt

Create a pull request in darthjee/sinclair that adds GitHub Copilot instructions for the repository.

Goal

Add a Copilot instructions document (and/or configuration) so that Copilot-generated code, comments, and documentation follow the project’s conventions. The instructions must be written in English.

Requirements (must be included in the Copilot instructions)

  1. Docker-based development workflow
    • Explain that development uses Docker and docker-compose.
    • Explain that developers use make dev to enter the dev environment (describe it succinctly, based on the repo’s tooling).
  2. Project purpose
    • Explain the purpose of this gem: it is a foundation for developing other gems by providing base classes.
    • Read and reflect the repository README and the existing classes to ensure the description matches the code.
  3. Language requirement
    • State clearly: all PRs, code, comments, and documentation must be written in English.
  4. Tooling / CI
    • Mention that the project runs rspec, rubocop, and yardstick (confirm via .circleci/config.*).
    • Mention that documentation is generated with YARD.
  5. Testing guidelines
    • Aim to have at least one spec for each file.
    • Note that files without specs are listed in config/check_specs.yml.
    • Prefer not to use mocks in specs.
    • Prefer one expectation per spec.
  6. Code quality / style
    • Emphasize Clean Code practices.
    • Follow Sandi Metz Ruby principles: small methods, single responsibility classes, and avoid violating the Law of Demeter.

Implementation details

  • Determine the correct location/format for Copilot instructions for this repository (e.g., .github/copilot-instructions.md or other GitHub-supported location).
  • Add/update any necessary files so the instructions are discoverable by Copilot.
  • Keep the instructions concise but actionable, using bullet points where appropriate.

Acceptance criteria

  • A PR exists with the new Copilot instructions committed.
  • Instructions are in English and cover all points above.
  • Any references to commands/tools are accurate for this repo (validated by inspecting existing files like README.md, Makefile, docker-compose.yml, gem structure, and .circleci/config.yml).
  • No unrelated formatting or whitespace churn.

This pull request was created from Copilot chat.


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

Co-authored-by: darthjee <3843066+darthjee@users.noreply.github.com>
Copilot AI changed the title [WIP] Add GitHub Copilot instructions for repository Add GitHub Copilot instructions for Sinclair Mar 3, 2026
@darthjee darthjee marked this pull request as ready for review March 3, 2026 16:18
@darthjee darthjee merged commit 9b40499 into master Mar 3, 2026
2 of 3 checks passed
@darthjee darthjee deleted the copilot/add-copilot-instructions branch March 3, 2026 17:07
darthjee added a commit that referenced this pull request Mar 8, 2026
Co-authored-by: darthjee <3843066+darthjee@users.noreply.github.com>
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.

2 participants