mirror of
https://github.com/DeBrosOfficial/network.git
synced 2025-12-13 03:48:49 +00:00
6a86592cad
- Consolidated development commands into a new `dev` command group for better organization. - Introduced a `prod` command group to manage production environment operations. - Updated Makefile to simplify the development environment setup and improve logging. - Enhanced README to clarify the development process and health check requirements. - Removed deprecated configuration and service management commands to streamline the CLI interface.
48 lines
999 B
Markdown
48 lines
999 B
Markdown
# 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
|
|
|
|
```bash
|
|
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/dbn health
|
|
./bin/dbn peers
|
|
./bin/dbn status
|
|
````
|
|
|
|
## Versioning
|
|
|
|
- The CLI reports its version via `dbn 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!
|