Skip to content

Conversation

@dblock
Copy link
Collaborator

@dblock dblock commented Dec 30, 2025

Summary

I've migrated a project to danger-pr-comment in dblock/ruby-enum#52.

This PR improves the README documentation with better organization, clearer installation instructions, and version pinning for stability.

Documentation Improvements

  • Add comprehensive Prerequisites section with example Gemfile and Dangerfile setup
  • Reorganize Requirements section into Implementation Details for better clarity
  • Move Dangerfile report examples into dedicated JSON Report Output subsection
  • Improve Inputs section structure with clearer subsection headers for each workflow

Installation Enhancements

  • Clarify which workflow files (.github/workflows/danger.yml and .github/workflows/danger-comment.yml) are overwritten with --force flag
  • Add explicit example command demonstrating how to use the --force option
  • Update all workflow references from @main to @v0.1.0 for version pinning
  • Apply version updates to both README examples and install script

Benefits

  • Better onboarding experience for new users with prerequisites upfront
  • More stable installations using versioned workflow references
  • Clearer documentation structure and improved readability
  • Explicit examples for common use cases

Test plan

  • Review documentation changes for clarity and accuracy
  • Verify example commands are correct
  • Confirm workflow references point to valid v0.1.0 tag
  • Check that all sections flow logically

🤖 Generated with Claude Code

@numbata
Copy link
Owner

numbata commented Jan 2, 2026

rebase from main?

dblock and others added 3 commits January 2, 2026 17:30
- Clarify which workflow files are overwritten with --force flag
- Add explicit example command for using --force option
- Improve documentation readability and structure

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Change workflow references from @main to @v0.1.0 for stability
- Update both README.md examples and install script
- Pin to specific version for reproducible installations

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Add Prerequisites section with example Gemfile and Dangerfile setup
- Reorganize Requirements into Implementation Details section
- Move Dangerfile report examples into dedicated JSON Report Output section
- Improve Inputs section structure with clearer subsection headers
- Enhance documentation flow for easier onboarding

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@dblock dblock force-pushed the update-readme-install-instructions branch from 2cce0f5 to 4d6611a Compare January 2, 2026 22:33
@github-actions
Copy link

github-actions bot commented Jan 2, 2026

Danger Report

No issues found.

View run

@dblock dblock force-pushed the update-readme-install-instructions branch 3 times, most recently from 7bbc6c5 to 6d7d57c Compare January 2, 2026 22:45
@dblock
Copy link
Collaborator Author

dblock commented Jan 2, 2026

rebase from main?

Done. Do read my changes, I may have missed something in the merge.

@dblock dblock requested a review from numbata January 2, 2026 22:46
@dblock dblock force-pushed the update-readme-install-instructions branch from 6d7d57c to 93ef977 Compare January 3, 2026 00:51
- Add example `with` block showing ruby-version and bundler-cache configuration
- Update both README.md example and install script
- Help users understand how to customize workflow inputs

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@dblock dblock force-pushed the update-readme-install-instructions branch from 93ef977 to 1409be4 Compare January 3, 2026 00:52
@dblock dblock merged commit 58e325d into numbata:main Jan 3, 2026
3 checks passed
@dblock dblock deleted the update-readme-install-instructions branch January 3, 2026 02: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