Skip to content

Latest commit

 

History

History
75 lines (54 loc) · 2.27 KB

index.md

File metadata and controls

75 lines (54 loc) · 2.27 KB
title
Get involved

Get involved

Feedback and discussion

How to contribute to the maintenance or development of Stack

A guide is provided to help potential contributors to the Stack project.

If you have already installed a version of Stack and the Git application the followings steps should get you started with building Stack from source with Stack:

  1. Clone the stack repository from GitHub with the command:

    git clone https://github.com/commercialhaskell/stack.git
    
  2. Change the current working directory to the cloned stack directory with the command:

    cd stack
    
  3. Build the stack executable using a preexisting installation of Stack with the command:

    stack build
    
  4. Once the stack executable has been built, check its version with the command:

    stack exec -- stack --version
    

    Make sure the version is the latest one.

  5. In the GitHub repository's issue tracker, look for issues tagged with newcomer friendly and awaiting pull request labels.

If you need to check your changes quickly command:

stack repl

and then, at the REPL's prompt, command:

:main --stack-root=<path_to_root> --stack-yaml=<path_to_stack.yaml> <COMMAND>

This allows you to set a special Stack root (instead of the default Stack root) and to target your commands at a particular stack.yaml file instead of the one found in the current directory.