Skip to content

Hackage Package Checklist

Simon Hudon edited this page Dec 16, 2016 · 1 revision

Checklist taken from haskell-package-checklist

Item Done / Good
Use Git for source control x
Host on GitHub x
Build with Stack x
Define with hpack
Name with kebab-case x
Use Semantic Versioning
License your package x
Write a README bad
Keep a change log
Write a synopsis x
Avoid heavy dependencies
Include extra-source-files x
Fix package warnings
Put Haskell files in source/
Match package and module names
Require one import
Expose implementation details
Build -Wall clean
Follow most HLint suggestions
Format code with hindent
Write documentation with examples
Test with Tasty using Hspec
Run tests on Travis CI
Keep executables small
Benchmark with Criterion
Automate releases
Clone this wiki locally