BetterThanTomorrow/calva

Provide a minimal complete example on how to jack-in

Open

#779 opened on Sep 6, 2020

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Clojure (1,243 stars) (194 forks)batch import
documentationgood first issue

Description

To make the VSCode+Calva combination more attractive to newcomers, lower some of the barriers of entry. That means, in Getting Started, show a simple way to get from an empty directory to having a REPL ready to go. This doesn't force people to step away from the Calva docs to research lein oder tools-deps. Instead, provide two minimal example files that Calva accepts as a valid starting point.

Contributor guide

Tech stack
None
Domain
documentationdeveloper experience
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Create two minimal project files (one for Leiningen and one for tools.deps) that Calva can accept for jack in. Place them in the getting started documentation. Ensure they are minimal and work out of the box. Refer to existing examples in the Calva repo for structure.
Provide a minimal complete example on how to jack-in · BetterThanTomorrow/calva#779 | Good First Issue