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 (194 forks)batch import
documentationgood first issue

Repository metrics

Stars
 (1,243 stars)
PR merge metrics
 (Avg merge 5d 20h) (7 merged PRs in 30d)

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

Research direction
Review Calva's documentation on jack in and create minimal Leiningen and deps.edn files that work with Calva's REPL. Look at existing examples in the repository.
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitClojure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75