Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Bug Report
about: Report a bug or unexpected behaviour
title: "[Bug] "
labels: bug
assignees: ''
---

## Description

A clear and concise description of the bug.

## Steps to Reproduce

1. Go to '...'
2. Click on '...'
3. See error

## Expected Behaviour

A clear and concise description of what you expected to happen.

## Actual Behaviour

A clear and concise description of what actually happens.

## Environment

- OS: [e.g. macOS 14, Ubuntu 22.04]
- Browser / Node version: [e.g. Chrome 123, Node 20]
- Wallet: [e.g. MetaMask 11.x]
- Network: [e.g. Sepolia]
- App version / commit: [e.g. v0.1.0 or git SHA]

## Additional Context

Add any other context, screenshots, or console output here.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Feature Request
about: Suggest a new feature or improvement
title: "[Feature] "
labels: enhancement
assignees: ''
---

## Description

A clear and concise description of the feature you would like to see.

## Motivation

Why is this feature needed? What problem does it solve or what value does it add?

## Proposed Solution

Describe how you would like the feature to work. Include any API, UI, or smart-contract changes you have in mind.

## Alternatives Considered

Any alternative approaches you have thought of and why you prefer the proposed solution.

## Additional Context

Add any other context, mockups, or references here.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/good-first-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Good First Issue
about: A well-scoped task that is suitable for first-time contributors
title: "[Good First Issue] "
labels: good first issue
assignees: ''
---

## Description

A clear and concise description of the task and what needs to be done.

## Acceptance Criteria

- [ ] Criterion 1
- [ ] Criterion 2
- [ ] Relevant tests pass (`npm run test:unit`)
- [ ] Code is formatted and linted (`npm run format && npm run lint`)

## Helpful Links

- [Contributing Guide](../../CONTRIBUTING.md)
- [README](../../README.md)
- [User Guide](../../USER_GUIDE.md)

## Notes for New Contributors

Feel free to ask questions in the comments. We are happy to help you get started!
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contributing to Reputation-Gated-Airdrop

Thank you for your interest in contributing! This project implements ZKML-powered, Sybil-resistant airdrops using EBSL (Evidence-Based Subjective Logic) trust scores to gate and scale token distributions.

## Areas Where Contributions Are Welcome

- **Smart Contracts** — Solidity contracts for ECDSA and ZK claim paths (`contracts/`)
- **EZKL Circuits** — Zero-knowledge ML proof circuits and WASM integration
- **Trust Score Models** — EBSL-based reputation scoring logic and Jupyter notebooks (`Notebooks/`)
- **Documentation** — Guides, architecture docs, and inline comments (`documentation/`)
- **Frontend** — SvelteKit UI components, stores, and Web3 integrations (`src/`)

## How to Contribute

1. **Fork** the repository on GitHub.
2. **Create a branch** from `main` with a descriptive name:
```bash
git checkout -b feat/your-feature-name
```
3. **Make your changes**, ensuring you follow the existing code style:
```bash
npm run format && npm run lint
```
4. **Run the tests** to confirm nothing is broken:
```bash
npm run test:unit
```
5. **Open a Pull Request** against the `main` branch with a clear description of the change.

## Pull Request Guidelines

- Keep PRs focused — **one logical change per PR**.
- Reference any related issue in the PR description (e.g. `Closes #42`).
- Include a brief summary of *what* changed and *why*.
- Ensure all CI checks pass before requesting a review.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025-2026 Oliver C. Hirst

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,9 @@ If both are configured, the UI will prioritize the ZK path by default.
- `yarn lint`: Check for linting and formatting issues.
- `yarn format`: Automatically format the code.

```
## Related Projects

```
- **<a href="https://github.com/Steake/EQBSL">EQBSL</a>** — The trust-as-ledgered-state framework powering the reputation scoring. TypeScript/Angular.
- **<a href="https://github.com/Steake/BitCell">BitCell</a>** — Consensus through cellular automaton warfare using EBSL trust scores. Rust.
- **<a href="https://github.com/Steake/shannon-uncontained">shannon-uncontained</a>** — Agentic pen-testing fork with EQBSL epistemic bookkeeping. JavaScript.
- **<a href="https://github.com/Steake/Clario">Clario</a>** — Crypto-native tutoring marketplace powered by EQBSL reputation. TypeScript/React.
Loading