diff options
| author | LLLL Colonq <llll@colonq> | 2023-11-16 19:06:43 -0500 |
|---|---|---|
| committer | LLLL Colonq <llll@colonq> | 2023-11-16 19:06:43 -0500 |
| commit | dcef0b65069fb38fd0f6c4382353167f603ebff1 (patch) | |
| tree | 45954ffe308c3dd056e6af4f734e6d2af89e5856 /deps/discord-haskell/docs/contributing.md | |
Initial commit
Diffstat (limited to 'deps/discord-haskell/docs/contributing.md')
| -rw-r--r-- | deps/discord-haskell/docs/contributing.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/deps/discord-haskell/docs/contributing.md b/deps/discord-haskell/docs/contributing.md new file mode 100644 index 0000000..56da78f --- /dev/null +++ b/deps/discord-haskell/docs/contributing.md @@ -0,0 +1,17 @@ + +### Contributing + +The library tries to hide as much detail from the user as reasonable. Lean towards making the library code uglier than the user code. The library does not meet this standard yet, but ideals make hypocrits of us all. + +A user should not have to import anything from `Discord.Internal.*` (although they can futz with the internals if they want to) + +#### Formatting + +Some of the code is moldy, and some is merely old. + +The library is somewhat open to code format style. +Try to match the formatting of the code around you. +Planning to use ormolu to autoformat the sourcecode eventually +(see [the formatting tracking issue](https://github.com/aquarial/discord-haskell/issues/87)) + +When in doubt make it look nice. |