Skip to content

Chore: Update docs on how to register a new Operation #4

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Oct 31, 2025
Merged

Chore: Update docs on how to register a new Operation #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d63516f
Update operator extension docs with more detail.
tavrelkate Oct 9, 2025
ffc8348
Refactor README to streamline operator documentation
tavrelkate Oct 17, 2025
e7a71b2
Update table of content; Update paragraphs.
tavrelkate Oct 31, 2025
99c0a64
Clickable links.
tavrelkate Oct 31, 2025
e169385
Update CONTRIBUTING.md
tavrelkate Oct 31, 2025
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
53 changes: 25 additions & 28 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,59 +1,56 @@
# Contribution Guide

**Contributions are very welcome!** Whether it's a small typo fix, a new operator, a better example, or a larger refactor — your help makes this gem better. If you're unsure where to start, open an issue and we can figure it out together.
# Contribution Guide

**Contributions are very welcome!** Whether it's a small typo fix, a new operator, a better example, or a larger refactor — your help makes this gem better. If you're unsure where to start, open an issue and we can figure it out together.

## Quick links (README)
- **Install & Quick start:** see [README → Install](./README.md#install) and [Quick start](./README.md#quick-start)
- **How Engine works (value vs lazy/enumerable):** see [README → How](./README.md#how)
- **Supported operations:** see [README → Supported Built-in Operations](./README.md#supported-built-in-operations)
- **Public Interface:** see [README → Public Interface](./README.md#public-interface)
- **Compliance & tests:** see [README → Compliance & tests](./README.md#compliance--tests)


- **How the engine works (value vs lazy/enumerable):** see [README → How](./README.md#how)
- **Supported operations:** see [README → Supported Operations (Built‑in)](./README.md#supported-operations-built-in)
- **Adding operations:** see [README → Adding Operations](./README.md#adding-operations)
- **JsonLogic semantics (comparisons & truthiness):** see [README → JsonLogic Semantic](./README.md#jsonlogic-semantic)
- **Compliance & tests:** see [README → Compliance and tests](./README.md#compliance-and-tests)

## Running tests & compliance

Use the **same commands** as in the README’s [Compliance & tests](./README.md#compliance--tests) section.


Use the **same commands** as in the README’s [Compliance and tests](./README.md#compliance-and-tests) section.

## How to contribute

1. Fork the repo and create a branch from `main`
2. Make your change (code, docs, or tests)
3. Include examples for new operators or pretty mappings
4. Update `README.md` if public behavior changes
5. Run your tests by `rake`
1. Fork the repo and create a branch from `main`.
2. Make your change (code, docs, or tests).
3. Include examples for new operators or pretty mappings.
4. Update `README.md` and docs if public behavior changes.
5. Run your tests.
6. Open a Pull Request and describe:
- What changed and why
- Any breaking impacts
- Before/after output if applicable

### Adding an operator

Operator adding and registration are described in the README’s [Extending (add your own operator)](./README.md#extending-add-your-own-operator) section.

Auto-registration is enabled in `lib/json_logic/operations/`
Operator creation and registration are described in the README’s [Adding Operations](./README.md#adding-operations) section.

Auto-registration is enabled for classes under `lib/json_logic/operations/`.

## Coding style

Please follow the conventions listed in the README and keep operators **pure** (no IO/network/shell).
Match the semantics from the official docs:
- Operations: https://jsonlogic.com/operations.html
- Truthiness: https://jsonlogic.com/truthy.html
- **Follow [README → Security](./README.md#security)**
- Prefer simple, composable code.
- Match the semantics from the official docs:
- Operations: <https://jsonlogic.com/operations.html>
- Truthiness: <https://jsonlogic.com/truthy.html>
- When relevant, use `using JsonLogic::Semantics` to align comparisons/truthiness with JsonLogic.

## PR checklist

- [ ] Tests or examples included (when applicable)
- [ ] Compliance suite passes (see [README](./README.md#compliance--tests))
- [ ] README updated if user-facing behavior changed

- [ ] Compliance suite passes (see [README → Compliance and tests](./README.md#compliance-and-tests))
- [ ] README/docs updated if user‑facing behavior changed

## Versioning

We use **Semantic Versioning** (MAJOR.MINOR.PATCH).

Bump lib/json_logic/version.rb using SemVer.
Update CHANGELOG.md.
- Bump `lib/json_logic/version.rb` using SemVer.
- Update `CHANGELOG.md`.
Loading