DeBros/network
4
0
Fork 0
mirror of https://github.com/DeBrosOfficial/network.git synced 2025-10-06 10:49:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
network/CONTRIBUTING.md

1.4 KiB
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://git.debros.io/DeBros/network.git
cd network
make deps

Build, Test, Lint

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

Local Development

Start a small cluster for manual testing:

make run-node                              # bootstrap (role=bootstrap)
# In new terminals (replace with printed peer.info if needed):
make run-node2 BOOTSTRAP="$(cat data/bootstrap/peer.info)" HTTP=5002 RAFT=7002 P2P=4002
make run-node3 BOOTSTRAP="$(cat data/bootstrap/peer.info)" HTTP=5003 RAFT=7003 P2P=4003

Useful CLI commands:

./bin/network-cli health
./bin/network-cli peers
./bin/network-cli status

Versioning

  • The CLI reports its version via network-cli 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!