docs: add repository contributor guidelines - #226
Merged
toshimaru merged 2 commits intoAug 11, 2026
Conversation
Co-authored-by: Codex <noreply@openai.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new contributor-facing documentation file (AGENTS.md) that describes how this repository is structured and how contributors should build, validate, and submit changes for the RailsDoc Jekyll site.
Changes:
- Introduces
AGENTS.mddescribing generated vs hand-maintained directories and the Rails submodule workflow. - Documents local development/build commands (Bundler, Jekyll, and Rake tasks) plus testing/validation expectations.
- Defines coding conventions and PR/commit hygiene guidance for common file types in this repo.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
This pull request adds a new documentation file,
AGENTS.md, which outlines repository guidelines for contributors. The document provides clear instructions on project structure, build and development commands, coding conventions, testing practices, and expectations for commits and pull requests.Repository documentation improvements:
AGENTS.mdwith detailed guidelines on project structure, module organization, and which directories are hand-maintained versus generated.