diff options
| author |  Chloe Kudryavtsev <code@toast.bunkerlabs.net> | 2023-03-26 18:31:42 -0400 |
|---|---|---|
| committer | Chloe Kudryavtsev <code@toast.bunkerlabs.net> | 2023-03-26 18:31:42 -0400 |
| commit | 546df6db951a308c017272c506940d81f1c34d37 (patch) | |
| tree | 72814d6d01c208c970c39fd2876b0d3a11191f0c | |
| parent | meta: update readme and project metadata (diff) | |
meta: add contributing
| -rw-r--r-- | CONTRIBUTING.md | 17 | ||||
| -rw-r--r-- | README.md | 8 |
2 files changed, 21 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b91076f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Guidelines for contributing to Jurl +Thanks for taking the time to contribute! + +Please read this document before making contributions. If you find anything missing of not appropriate, please do not hesitate and create an issue in this repository. + +## Build Errors +Some build errors are due to bad code, while others are due to your system setup. +I can only help with the former. +To submit a build-error related issue, please include a reference to the exact part of the code causing the problem (legitimate instances of this will usually be related to undefined symbols due to a lack of versioning). + +## Missing Features +If a feature of libcurl you depend on is missing, let me know! +It may be possible to add it. +Bonus points if you have an idea on how to represent it. + +Please note that the high level `jurl` API is meant to be HTTP-only. +However, `jurl/native` is fully unopinionated, and can be used to build your own higher level API. @@ -2,9 +2,9 @@ Janet Curl (secretly Jean Curl) A libcurl easy API wrapper for Janet. -It's divided into two components: `jurl-native`, which holds the low level C interfacing, and the high level `jurl` janet wrapper. +It's divided into two components: `jurl/native`, which holds the low level C interfacing, and the high level `jurl` janet wrapper. -`jurl-native` is mostly feature complete. +`jurl/native` is mostly feature complete. If something you depend on is missing, and you have a good idea on how to represent it in Janet, let me know in the issues. `jurl`'s core functionality is complete. @@ -52,8 +52,8 @@ A post with json: # -> {:body @"..." :error :ok :handle <jurl> :status 200} ``` -## Jurl-Native -`jurl-native` attempts to implement as much of libcurl's easy API in as direct a manner as possible. +## Jurl/Native +`jurl/native` attempts to implement as much of libcurl's easy API in as direct a manner as possible. In cases of bitmaps and enums (including magic numbers), they are translated as directly as possible from their C forms into keywords. For example, `CURLOPT_TCP_FASTOPEN` becomes `:tcp-fastopen`. |