mirror of https://github.com/DeBrosOfficial/orama.git synced 2026-03-27 12:44:13 +00:00

anonpenguin23 abcc23c4f3 refactor(monorepo): restructure repo with core, website, vault, os packages

- add monorepo Makefile delegating to sub-projects
- update CI workflows, GoReleaser, gitignore for new structure
- revise README, CONTRIBUTING.md for monorepo overview
- bump Go to 1.24

2026-03-26 18:21:55 +02:00

1.6 KiB

Raw Blame History

Contributing to Orama Network

Thanks for helping improve the network! This monorepo contains multiple projects — pick the one relevant to your contribution.

Repository Structure

Package	Language	Build
`core/`	Go 1.24+	`make core-build`
`website/`	TypeScript (pnpm)	`make website-build`
`vault/`	Zig 0.14+	`make vault-build`
`os/`	Go + Buildroot	`make os-build`

Setup

git clone https://github.com/DeBrosOfficial/network.git
cd network

Core (Go)

cd core
make deps
make build
make test

Website

cd website
pnpm install
pnpm dev

Vault (Zig)

cd vault
zig build
zig build test

Pull Requests

Fork and create a topic branch from main.
Ensure make test passes for affected packages.
Include tests for new functionality or bug fixes.
Keep PRs focused — one concern per PR.
Write a clear description: motivation, approach, and how you tested it.
Update docs if you're changing user-facing behavior.

Code Style

Go (core/, os/)

Follow standard Go conventions
Run make lint before submitting
Wrap errors with context: fmt.Errorf("failed to X: %w", err)
No magic values — use named constants

TypeScript (website/)

TypeScript strict mode
Follow existing patterns in the codebase

Zig (vault/)

Follow standard Zig conventions
Run zig build test before submitting

Security

If you find a security vulnerability, do not open a public issue. Email security@debros.io instead.

Thank you for contributing!

1.6 KiB Raw Blame History