docs: improve README and Copilot instructions#151
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR improves repository documentation for users and future coding-agent sessions by clarifying usage, setup, testing, linting, and architectural conventions.
Changes:
- Expands README usage examples for defining CSV formats, named styles, and Rails rendering.
- Documents dependency installation, base test/lint commands, single-spec runs, and appraisal matrix runs.
- Adds repository-specific Copilot instructions covering commands, architecture, and key conventions.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Updates project description, prerequisites, installation URL, usage examples, test commands, and typo fixes. |
| .github/copilot-instructions.md | Adds guidance for build/test/lint workflows and summarizes architecture and DSL conventions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
eitoball
force-pushed
the
copilot/docs-refresh
branch
2 times, most recently
from
b67664e to
5e1b356
Compare
eitoball
force-pushed
the
copilot/docs-refresh
branch
from
5e1b356 to
96b0b11
Compare
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
eitoball
force-pushed
the
copilot/docs-refresh
branch
from
96b0b11 to
d425d18
Compare
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.
Summary
Testing