https://github.com/rambler-digital-solutions/danger-readme_docs

https://github.com/rambler-digital-solutions/danger-readme_docs

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/rambler-digital-solutions/danger-readme_docs
• Owner: rambler-digital-solutions
• License: mit
• Created: 2021-03-25T09:08:07.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-03-26T09:47:02.000Z (over 3 years ago)
• Last Synced: 2024-10-20T09:58:40.521Z (26 days ago)
• Language: Ruby
• Size: 15.6 KB
• Stars: 0
• Watchers: 9
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# danger-readme_docs

Danger plugin to validate sub README mention in main README file

## Installation

    $ gem install danger-readme_docs

## Usage

    Add this to your Dangerfile:

    readme_docs.lint

## Development

1. Clone this repo

2. Run `bundle install` to setup dependencies.

3. Run `bundle exec rake spec` to run the tests.

4. Use `bundle exec guard` to automatically have tests run as you make changes.

5. Make your changes.