haskell / haskell/security-advisories

publish a c-lib best practices guide

Open
#284 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Haskell
Stars
64
Forks
27
Avg merge
3h 39m
Merged PRs (30d)
1

Description

Tracking the idea of publishing a best practices guide for Haskell projects that use or bundle/vendor C libraries.

* Two recommended approaches:
* Use system clibs
* Bundle the clib in a standalone cabal package, then depend on that. e.g.:
* https://hackage.haskell.org/package/lzma-clib
* https://hackage.haskell.org/package/libyaml-clib
* Write up the recommended approaches and discourage other kinds of vendoring.

Contributor guide

Open the contributing guide

Research direction

Use the issue's two recommended approaches as the outline: system C libraries, or a standalone Cabal package such as lzma-clib or libyaml-clib. Research and document those approaches, explain why other vendoring methods are discouraged, and consider the guide complete when the recommendations are clear for Haskell projects that use or bundle C libraries.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, haskell
Domain
documentation
Issue type
Documentation
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.