Skip to content
Open
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
31 changes: 31 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Contributing to the Base node repository

Thank you for considering a contribution!

## Getting started

1. Fork the repository and clone your fork.
2. Run `docker compose up` to start a node locally.
3. Use a new branch per change (`git checkout -b feature/your-description`).

## Code style

- Shell scripts should use `#!/usr/bin/env bash` and `set -euo pipefail`.
- Go code follows `gofmt` style; run `go fmt ./...` before committing.
- Document any new files or APIs.

## Testing your changes

- If you modify the compose setup, run `docker compose config` to ensure the YAML is valid.
- For Go changes, run `go test ./...`.
- For docs, ensure Markdown renders properly and links are correct.

## Opening a pull request

Describe:

- The purpose of your change.
- How you tested it.
- Any related issues it addresses.

Maintainers will review and provide feedback. Welcome aboard!