luckyframework / luckyframework/lucky_cli

Raise if script/setup has never been run

Open
#504 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
92
Forks
48
PR merge metrics
No merged PRs in 30d

Description

Some people skip the script/setup and then their system is not working. We should add something to script/system_check that before anything else checks that script/setup has been run. This will also encourage people to use script/setup and keep it up to date!

The way I think we can do this is by touching a file at the end of script/setup touch .lucky_has_been_setup or something like that. Then we add that to the .gitignore and add script/system_check that looks for that file and prints that they should run script/setup

Thoughts @jwoertink @edwardloveall ?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read script/setup and script/system_check first, then inspect .gitignore. Add a setup marker at the end of script/setup, ignore it, and have script/system_check detect a missing marker and tell users to run script/setup.

Written by the indexing model from the issue text.

Assessment

Tech stack
crystal
Domain
cli, tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.