haskell / haskell/cabal

cabal init should create a .gitignore with dist-newstyle in it.

Open
#10,036 0 comments 11 reactions 0 assignees View on GitHub
cabal-install: cmd/init type: enhancement
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

It's quite irritating to initialise new projects and fall in the same trap each time: `dist-newstyle` is (rightfully) caught by git when one adds the newly created files. This trips quite a large proportion of newcomers I mentor.

A nice thing would be to have git support through a `--vcs=git` flag so that people who don't care about it don't get their folders cluttered.

Contributor guide

Open the contributing guide

Research direction

Start at the cabal init command and trace how newly initialized project files are created. Determine how a --vcs=git option should control creation of a .gitignore containing dist-newstyle, and verify that the generated files match the requested behavior.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.