DeBros/network
4
0
Fork 0
mirror of https://github.com/DeBrosOfficial/network.git synced 2025-12-11 07:58:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
network/CONTRIBUTING.md
anonpenguin23 660008b0aa refactor: rename DeBros to Orama and update configuration paths 
- Replaced all instances of DeBros with Orama throughout the codebase, including CLI commands and configuration paths.
- Updated documentation to reflect the new naming convention and paths for configuration files.
- Removed the outdated PRODUCTION_INSTALL.md file and added new scripts for local domain setup and testing.
- Introduced a new interactive TUI installer for Orama Network, enhancing the installation experience.
- Improved logging and error handling across various components to provide clearer feedback during operations.
2025-11-26 13:31:02 +02:00

1007 B
Raw Blame History

Contributing to DeBros Network

Thanks for helping improve the network! This guide covers setup, local dev, tests, and PR guidelines.

Requirements

  • Go 1.22+ (1.23 recommended)
  • RQLite (optional for local runs; the Makefile starts nodes with embedded setup)
  • Make (optional)

Setup

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

Build, Test, Lint

  • Build: make build
  • Test: make test
  • Format/Vet: make fmt vet (or make lint)

Useful CLI commands:

```bash
./bin/orama health
./bin/orama peers
./bin/orama status

Versioning

  • The CLI reports its version via orama version.
  • Releases are tagged (e.g., v0.18.0-beta) and published via GoReleaser.

Pull Requests

  1. Fork and create a topic branch.
  2. Ensure make build test passes; include tests for new functionality.
  3. Keep PRs focused and well-described (motivation, approach, testing).
  4. Update README/docs for behavior changes.

Thank you for contributing!