owen/things-to-check
Archived
1
Fork 0
Code Pull requests Activity
No description
This repository has been archived on 2026-03-10. You can view files and clone it, but you cannot make any changes to its state, such as pushing and creating new issues, pull requests or comments.
114 commits 1 branch 0 tags 173 KiB
  • Rust 84.4%
  • HTML 8.2%
  • Shell 7.3%
  • Procfile 0.1%
Find a file
Exact
Owen Jacobson 2152da2024 hmm
2023-05-09 21:47:22 -04:00
.git-hooks Extracted checks into a tools directory. 2020-06-17 23:58:31 -04:00
proptest-regressions Switch from quickcheck to proptest. 2020-06-26 20:48:49 -04:00
src Unbreak builds to test build cancellation 2023-04-26 23:22:54 -04:00
templates Update fork ribbon 2022-12-13 17:56:57 -05:00
tools Move back to stable rust. 2022-06-08 00:43:44 -04:00
.envrc caps 2023-04-21 14:52:35 -04:00
.gitignore Port things-to-check to Rust as a learning exercise. 2020-06-03 23:26:02 -04:00
.gitlab-ci.yml Update .gitlab-ci.yml file 2022-06-26 20:43:57 +00:00
.travis.yml Move back to stable rust. 2022-06-08 00:43:44 -04:00
app.json App.json for Heroku Pipelines. 2020-06-04 01:59:30 -04:00
Cargo.lock Move to Askama templates. 2022-06-08 00:43:44 -04:00
Cargo.toml Unbreak builds to test build cancellation 2023-04-26 23:22:54 -04:00
LICENSE.md Port things-to-check to Rust as a learning exercise. 2020-06-03 23:26:02 -04:00
Procfile Renamed primary binary to web. 2020-06-04 01:04:08 -04:00
README.md Move tool installation into scripts. 2020-07-31 15:17:03 -04:00
rust-toolchain.toml Configure Rust version explicitly 2022-12-13 17:56:57 -05:00

README.md

Things To Check

Build Status

A friend of mine used to run an IRC bot that could provide "helpful" troubleshooting suggestions, based on places the folks in that chat had stubbed their toes in the past.

I thought this was such a good idea, I turned it into a web bot.

You Will Need

Want to work on this code, or run it yourself? Install the following:

Building, testing, &c follow Rust norms: use Cargo to build, test, or run the code locally.

Configuration

By default, this app will listen on http://localhost:3000/. You can change the port number by exporting a PORT environment variable in the process where this program runs.

Vocabulary

The list of suggestions is given by the src/things-to-check.yml file, which contains a YAML list of strings. Each string is a Markdown snippet to render in the page as a suggestion.

Stable links provide the user with an index into this list. When you insert new items, insert them at the end.

Git hooks

This project includes a pre-commit and a pre-merge-commit hook to run tests. Using this hook is optional, but it'll catch a lot of minor breakage before Travis does.

Security note: Enabling in-repository hooks means that anyone who can commit code to this repository can run that code on your computer. Only do this if you're willing to take that chance.

To set this up:

  • Install additional Rust components and Cargo binaries:

    tools/install-tool-dependencies

  • Configure Git to use these hooks:

    git config core.hooksPath .git-hooks

This only needs to be done once, and applies only to this project. To undo this, unset core.hooksPath:

git config --unset core.hooksPath

You can also temporarily suppress the hook with git commit --no-verify, if you have broken code you want to check in, or if the internet is unavailable for Cargo to download dependencies.