https://github.com/freckle/haskell-library-template

A template repository for haskell libraries
https://github.com/freckle/haskell-library-template

terraform-managed

Last synced: 8 months ago
JSON representation

A template repository for haskell libraries

• Host: GitHub
• URL: https://github.com/freckle/haskell-library-template
• Owner: freckle
• License: mit
• Created: 2022-06-01T15:10:32.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-01-10T14:19:13.000Z (over 1 year ago)
• Last Synced: 2025-01-10T14:28:53.165Z (over 1 year ago)
• Topics: terraform-managed
• Language: Nix
• Homepage:
• Size: 57.6 KB
• Stars: 0
• Watchers: 14
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.lhs
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# haskell-library-template

[![Hackage](https://img.shields.io/hackage/v/haskell-library-template.svg?style=flat)](https://hackage.haskell.org/package/haskell-library-template)

[![Stackage Nightly](http://stackage.org/package/haskell-library-template/badge/nightly)](http://stackage.org/nightly/package/haskell-library-template)

[![Stackage LTS](http://stackage.org/package/haskell-library-template/badge/lts)](http://stackage.org/lts/package/haskell-library-template)

[![CI](https://github.com/freckle/haskell-library-template/actions/workflows/ci.yml/badge.svg)](https://github.com/freckle/haskell-library-template/actions/workflows/ci.yml)

_Synopsis_

## Example

```haskell

someExample :: IO ()

someExample = putStrLn "Hello world"

```

## Development & Tests

```console

stack build --fast --pedantic --test --file-watch

```

---

## How to use this Template

Haskell library template used at Freckle.

### Create your repo

If you are working within the freckle org, use [github-vending-machine][ghvm]. Otherwise:

[ghvm]: https://github.com/freckle/github-vending-machine

```sh

gh repo create --template freckle/haskell-library-template --public freckle/

git clone git@github.com:freckle/

cd ./

```

### Rename your package

```sh

find -type f -exec \

  sed -i s/haskell-library-template/my-name/ {} +

```

Edit `package.yaml` as necessary.

### Enable release

When you are ready to release your library, simply remove the conditional from

the release workflow.

```diff

-      - if: false # Remove when ready to release

```

### Open repo up to [hacktoberfest][hacktoberfest] contributions

Add the `hacktoberfest` topic to your repo if

- you're planning on releasing it as open source, and

- you think it would benefit from and be amenable to public contributions

[hacktoberfest]: https://hacktoberfest.digitalocean.com/

---

[CHANGELOG](./CHANGELOG.md) | [LICENSE](./LICENSE)