Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add section about portability #296

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,3 +97,19 @@ to suggest for a core library (including one that affects several), please start
the maintainer(s) and/or main source repositories, as listed on Hackage. If the maintainer
is unsure of whether to proceed, they can come to the CLC for further guidance. On the other
hand, if you struggle to reach a responsive maintainer, come to the CLC directly.

## Portability

It is a priority of the CLC and the library maintainers to
ensure that core libraries remain portable. Core libraries are the building blocks
of the ecosystem and it's important that the same libraries are available to be used
on a variety of operating systems and architectures.

In particular:

* Libraries should remain compatible with a large range of platforms. Including but
not exclusive to standard linux distributions (aarch64 and x86_64), darwin systems and windows.
* Libraries should avoid using features which not all backends support such as `TemplateHaskell`.
For boot libraries, this is a hard requirement.