From d8c1b11c58b833e772bc109f3e7e2a3696787587 Mon Sep 17 00:00:00 2001 From: "Daniel (dB.) Doubrovkine" Date: Wed, 14 Oct 2026 17:26:51 -0400 Subject: [PATCH] Remove macOS metadata and add basic agent guidance Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .DS_Store | Bin 6148 -> 0 bytes .gitignore | 1 + AGENTS.md | 26 ++++++++++++++++++++++++++ 3 files changed, 27 insertions(+) delete mode 100644 .DS_Store create mode 100644 AGENTS.md diff --git a/.DS_Store b/.DS_Store deleted file mode 100644 index 1ad899dbcdc748036dd701eacb0ec11e243703d4..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeHKyJ`bL3>+mc4$`I(2Sbbi#2M3J zT*oXyY@Q(Y!ZDE|1kgGlC+ZoQs7@HV6)|Fx!@~RZ=JlH_u58Z)4k@C?#6Xc7@{2$qaAbO f?f5y0vab1>=e=-D3_9~cC+cUwb&*MdzgFN1-fR_w diff --git a/.gitignore b/.gitignore index 4b2b4ab..2ae702c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ *.gem +.DS_Store *.rbc .bundle .config diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..e429db1 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,26 @@ +# Agent Guide + +Hyperclient is a Ruby client for JSON HAL APIs, built on Faraday 2 and `faraday_hal_middleware`. + +## Layout + +- `lib/hyperclient.rb`: client entry point and configuration. +- `lib/hyperclient/`: resources, links, collections, attributes, and CURIEs. +- `test/`: Minitest tests and fixtures. +- `features/`: Spinach acceptance tests and supporting code. +- `examples/`: runnable usage examples. + +## Commands + +```sh +bundle install +bundle exec rake # Minitest, Spinach, and RuboCop +bundle exec rake test # Minitest only +bundle exec rake spinach # Acceptance tests only +bundle exec rake rubocop # Lint +bundle exec ruby -Itest test/hyperclient_test.rb +``` + +## Changes + +Follow existing Ruby conventions and preserve Ruby 2.7 compatibility. Add regression tests for behavior changes; use existing HTTP stubs rather than depending on external services. Update the README for public API changes and the changelog with the pull request number. See `CONTRIBUTING.md` for the full contribution workflow and `.github/workflows/` for the CI matrix.