You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 5dc40f6
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+36Lines changed: 36 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,6 +26,42 @@ We love your input! We want to make contributing to Embedding Bridge as easy and
26
26
2. Update the documentation if you're introducing new features.
27
27
3. The PR will be merged once you have the sign-off of at least one maintainer.
28
28
29
+
## Helper Scripts
30
+
31
+
The `scripts/` directory contains helper scripts to automate building and installing native dependencies:
32
+
33
+
-**build_aws.sh**: clones and builds all AWS C SDK libraries into `vendor/aws/install`.
34
+
-**build_arrow.sh**: downloads and builds Apache Arrow C++ (and optional GLib bindings via `--with-glib`), installing to `/usr/local` or the `ARROW_INSTALL_DIR` defined in this repository.
35
+
-**build_aws.md**: a human-readable guide describing the manual steps performed by `build_aws.sh`.
36
+
37
+
The Makefile provides targets that wrap these scripts:
38
+
```bash
39
+
make build-aws # builds all AWS C libraries
40
+
make build-arrow # builds Arrow C++ library only
41
+
make build-arrow-glib # builds Arrow C++ with GLib bindings
42
+
```
43
+
44
+
Be sure to run these targets before running `make`, building tests, or contributing code that depends on AWS or Arrow.
45
+
46
+
## Debugging
47
+
48
+
To enable detailed debug output when running Embedding Bridge commands, set the following environment variables in your shell:
49
+
50
+
```sh
51
+
EB_DEBUG=1 EB_DEBUG_LEVEL=5 <your-command>
52
+
```
53
+
54
+
-`EB_DEBUG=1` enables debug output.
55
+
-`EB_DEBUG_LEVEL` controls verbosity:
56
+
-`0` (none, no debug output)
57
+
-`1` (error)
58
+
-`2` (warn)
59
+
-`3` (info)
60
+
-`4` (debug)
61
+
-`5` (trace, very verbose)
62
+
63
+
This can help diagnose issues during development or when submitting bug reports.
64
+
29
65
## License
30
66
31
67
By contributing, you agree that your contributions will be licensed under the GNU General Public License v2.0.
0 commit comments