https://github.com/samesystem/pronto-docslint

https://github.com/samesystem/pronto-docslint

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/samesystem/pronto-docslint
• Owner: samesystem
• License: mit
• Created: 2019-04-05T06:07:28.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-04-05T06:31:14.000Z (over 5 years ago)
• Last Synced: 2024-04-24T21:43:48.487Z (8 months ago)
• Language: Ruby
• Size: 11.7 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Pronto Docslint

[![Build Status](https://travis-ci.org/samesystem/pronto-docslint.svg?branch=master)](https://travis-ci.org/samesystem/pronto-docslints)

[![codecov](https://codecov.io/gh/samesystem/pronto-docslint/branch/master/graph/badge.svg)](https://codecov.io/gh/samesystem/pronto-docslint)

Pronto runner for documentation checker

## Example configuration:

```yaml

# .pronto_docslint.yml

additions_treshold: 2

deletions_treshold: 2

watched_file_extensions:

  - rb

  - js

```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/samesystem/pronto-docslint. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the pronto-docslint project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/samesystem/pronto-docslint/blob/master/CODE_OF_CONDUCT.md).