https://github.com/swinton/linter-alex

📝Sensitive, considerate writing before you merge your Pull Requests
https://github.com/swinton/linter-alex

checks continuous-integration docs github-app linter markdown probot probot-app

Last synced: about 2 months ago
JSON representation

📝Sensitive, considerate writing before you merge your Pull Requests

• Host: GitHub
• URL: https://github.com/swinton/linter-alex
• Owner: swinton
• License: isc
• Archived: true
• Created: 2018-04-20T20:36:03.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-12-25T09:41:44.000Z (almost 5 years ago)
• Last Synced: 2024-09-22T13:02:12.343Z (about 2 months ago)
• Topics: checks, continuous-integration, docs, github-app, linter, markdown, probot, probot-app
• Language: JavaScript
• Homepage: https://github.com/apps/linter-alex
• Size: 124 KB
• Stars: 68
• Watchers: 4
• Forks: 5
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# linter-alex

[![build status](https://travis-ci.org/swinton/linter-alex.svg?branch=master)](https://travis-ci.org/swinton/linter-alex) [![coverage status](https://coveralls.io/repos/github/swinton/linter-alex/badge.svg?branch=master)](https://coveralls.io/github/swinton/linter-alex?branch=master) [![Greenkeeper badge](https://badges.greenkeeper.io/swinton/linter-alex.svg)](https://greenkeeper.io/)

> a GitHub App built with [probot](https://github.com/probot/probot) combining [Alex](http://alexjs.com/) with GitHub's [(beta) Checks API](https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/) to ensure **sensitive, considerate writing before you merge your Pull Requests**.

### Looking for an example?

[**Here you go**](https://github.com/swinton/example/runs/449335)! :eyes:

## Installation

Want to try it out? :sparkles: :cool: :sparkles: You can install the app directly from [**this page**](https://github.com/apps/linter-alex).

See [docs/deploy.md](docs/deploy.md) if you would like to run your own instance of this app.

## Limitations

Currently, [trees](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Tree-Objects) are fetched recursively for analysis via [this API](https://developer.github.com/v3/git/trees/#get-a-tree-recursively), which has a hard limit of 100,000 _entries_, where each entry is either a _blob_ object or a further _sub-tree_ object. If your repo has more entries than this, only the first 100,000 entries will be reachable by linter-alex.

## Feedback?

Please [**open an issue**](https://github.com/swinton/linter-alex/issues/new) :bow: