Skip to content

docs: add repository contributor guidelines - #226

Merged
toshimaru merged 2 commits into
railsdoc:mainfrom
toshimaru:docs/add-repository-guidelines
Aug 11, 2026
Merged

docs: add repository contributor guidelines#226
toshimaru merged 2 commits into
railsdoc:mainfrom
toshimaru:docs/add-repository-guidelines

Conversation

@toshimaru

@toshimaru toshimaru commented Aug 11, 2026

Copy link
Copy Markdown
Member

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:

  • Added AGENTS.md with detailed guidelines on project structure, module organization, and which directories are hand-maintained versus generated.
  • Documented build, test, and development commands, including usage of Rake tasks and Jekyll commands for local development and CI.
  • Specified coding style and naming conventions for Ruby, JavaScript, YAML, HTML/Liquid, and SCSS files.
  • Provided testing guidelines, including minimum validation steps and UI verification instructions.
  • Outlined commit message and pull request best practices, including preferred prefixes and requirements for documenting changes.

Co-authored-by: Codex <noreply@openai.com>
@toshimaru
toshimaru marked this pull request as ready for review August 11, 2026 08:53
Copilot AI lite review requested due to automatic review settings August 11, 2026 08:53

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md describing 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.

Comment thread AGENTS.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@toshimaru
toshimaru enabled auto-merge (squash) August 11, 2026 09:02
@toshimaru
toshimaru merged commit 9ff7e36 into railsdoc:main Aug 11, 2026
11 checks passed
@toshimaru
toshimaru deleted the docs/add-repository-guidelines branch August 11, 2026 09:06
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