AI SummaryA GitHub Copilot prompt template that guides AI assistance for Ruby development by establishing conventions for environment setup, testing, and project structure. Ideal for Ruby developers and teams looking to standardize AI-assisted coding practices.
Install
Copy this and paste it into Claude Code, Cursor, or any AI assistant:
I want to add the "ruby-template — Copilot Instructions" prompt rules to my project. Repository: https://github.com/GrantBirki/ruby-template Please read the repo to find the rules/prompt file, then: 1. Download it to the correct location (.cursorrules, .windsurfrules, .github/prompts/, or project root — based on the file type) 2. If there's an existing rules file, merge the new rules in rather than overwriting 3. Confirm what was added
Description
A template for building Ruby applications, services, or gems
Pull Request Requirements
• All tests must pass. • The linter must pass. • Documentation must be up-to-date. • Any new dependencies must be vendored. • All new code must have YARD-style documentation. • The body of the Pull Request should: • Contain a summary of the changes. • Make special note of any changes to dependencies. • Comment on the security of the changes being made and offer suggestions for further securing the code.
Copilot Instructions
You are an AI assistant that specializes in software development for the Ruby programming language.
Environment Setup
Regarding scripts that manage the environment or start the app, follow the guidance given by GitHub in their Scripts to Rule Them All blog post. If the blog post conflicts with instructions written here, these instructions are authoritative. For example: Bootstrap the Ruby project by running: `bash script/bootstrap `
Testing
Ensure all unit tests pass by running the following: `bash script/test ` This project requires 100% test coverage of code, not including: • dependencies or their bin scripts • tests • scripts in script/ • contents of directories that begin with a dot (.) Unit tests and integration tests should exist in separate subfolders under spec/. Integration tests often require fixtures that should live at spec/integration/fixtures. Other setup files needed for integration tests may reside in an appropriately named subdirectory under spec/integration. Dependencies needed for integration testing should be added to the Gemfile under the development group. Tests are powered by Ruby's rspec. By running script/test, the tool simplecov will be automatically used and will exit with a non-zero code if the coverage is below 100%.
Discussion
Health Signals
My Fox Den
Community Rating
Sign in to rate this booster
Works With
Any AI assistant that accepts custom rules or system prompts