Skip to content

docs: add contributing guidelines #898

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jca25 wants to merge 1 commit into
base: main
Choose a base branch
from
+26 −0
Open

docs: add contributing guidelines #898

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 26 additions & 0 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing Guidelines

Thank you for your interest in contributing to Base Node! This document
provides best practices and instructions for making contributions.

## Getting started

1. Fork the repository and clone your fork.
2. Create a new branch for your change.
3. Install dependencies as described in the README.
4. Ensure you have Go 1.20 or later installed.

## Coding standards

- Follow the existing project structure and import paths.
- Run `go vet` and `golangci-lint` before submitting a PR.
- Write unit tests for new functions or significant changes.

## Submitting changes

1. Keep your PRs focused and small.
2. Include a clear description of what your change does.
3. Update documentation if your change affects behaviour.
4. Ensure all tests pass: `go test ./...`.

We appreciate your contributions and reviews help keep the codebase healthy!