kowainik/hintman
1
1
Fork 0
mirror of https://github.com/kowainik/hintman.git synced 2024-11-23 08:34:55 +03:00
Code Issues Projects Releases Wiki Activity
🔫 GitHub application to suggest hints
67 Commits 2 Branches 0 Tags 399 KiB
Haskell 100%
main
Go to file
Dmitrii Kovanikov 3dd38fa789
Introduce 'Delta' data type to simplify diff checks (#161) 
* Introduce 'Delta' data type to simplify diff checks

* Update src/Hintman/Core/Delta.hs

Co-Authored-By: Veronika Romashkina <vrom911@gmail.com>

* Update top-level comments

Co-authored-by: Veronika Romashkina <vrom911@gmail.com>
2020-01-12 15:42:37 +00:00
.github Add CODEOWNERS 2019-11-02 09:28:24 +04:00
app [#11] Use optparse-applicative for parsing configuration (#15) 2018-11-04 13:45:07 +08:00
src Introduce 'Delta' data type to simplify diff checks (#161) 2020-01-12 15:42:37 +00:00
test Introduce 'Delta' data type to simplify diff checks (#161) 2020-01-12 15:42:37 +00:00
.gitignore [#66] Figure out authentication for GitHub App and use proper token for submitting comments (#68) 2019-08-18 13:40:19 +04:00
.stylish-haskell.yaml Create the project 2018-11-03 14:39:15 +08:00
.travis.yml Use relude-0.6.0.0 (#149) 2019-11-02 09:29:18 +04:00
CHANGELOG.md Create the project 2018-11-03 14:39:15 +08:00
hintman.cabal Introduce 'Delta' data type to simplify diff checks (#161) 2020-01-12 15:42:37 +00:00
LICENSE Create the project 2018-11-03 14:39:15 +08:00
Procfile [#130] Force log output (#140) 2019-10-21 13:39:46 +04:00
README.md Extend the README (#147) 2019-10-22 08:52:06 +03:00
stack.yaml Use relude-0.6.0.0 (#149) 2019-11-02 09:29:18 +04:00

README.md

hintman

GitHub App Build status MPL-2.0 license

Hintman is a GitHub application that automatically submits reviews to opened pull requests in your repositories with inline hints. It heavily makes the use of the GitHub suggestions feature, so that all the hints could be applied in one click.

⚠️ WARNING: Hintman is in early beta phase. ⚠️

References

Hintman is inspired by the Hitman video game series. The standard replies of Hintman are based on the quotes from the game. And the current avatar is the hint as well.

Features

Current set of features includes:

  • Trailing spaces removal via GitHub suggestion mechanism
  • Trailing newlines removal via GitHub suggestion mechanism
  • [Haskell only] Submitting inline HLint suggestions to Haskell source code files

Stay tuned and watch for the updates!

Motivation

If you're an open source maintainer, reviewing incoming pull requests from various contributors can be tedious. You want to ensure excellent code quality. But you don't want to spend your time on things that can be automated. Hintman helps you with that! It submits inline suggestions to all open pull requests so you can apply them immediately.

Installation

To enable Hintman reviews, follow the link below and install it for all accounts and repositories where you would like it to use.

Hintman's review

Based on the gathered feedback, there could be two states of the Hintman bot:

  1. No hints were found for the pull request. In this case Hintman will Approve the PR and leave the "There is no place for me here... I will choose the truth I like." comment. You would see the following: Hintman approve
  2. Hintman could appeal to some enhancements. Some of the supported by the app changes can be made. In this case, Hintman will Comment the PR and leave the "Do you know why your PR is still not approved? Because I chose not to approve it. But they will." comment along with the hints as GitHub suggestions. You would see the following: Hintman not approves