mirror of https://github.com/ipfs/kubo.git synced 2026-02-21 10:27:46 +08:00

docs: add developer guide for local development workflow (#11128 )

addresses https://discuss.ipfs.tech/t/19933

- add docs/developer-guide.md with prerequisites, build, test, and troubleshooting
- link from README.md, docs/README.md, and CONTRIBUTING.md
- document test suite differences (unit vs e2e, test/cli vs test/sharness)
- include tips for running specific tests during development

2026-01-07 17:09:13 +01:00

1.7 KiB

Raw Blame History

Developer Documentation and Guides

If you are looking for User Documentation & Guides, please visit docs.ipfs.tech or check General Documentation.

If you’re experiencing an issue with IPFS, please follow our issue guide when filing an issue!

Otherwise, check out the following guides to using and developing IPFS:

General Documentation

Configuration reference
- Datastore configuration
- Experimental features

Developing `kubo`

Developer Guide - prerequisites, build, test, and contribute
Contributing Guidelines for IPFS projects and for Go code specifically
Building on Windows
Performance Debugging Guidelines
Release Checklist

Guides

How to Implement an API Client
Connecting with Websockets — if you want js-ipfs nodes in web browsers to connect to your kubo node, you will need to turn on websocket support in your kubo node.

Advanced User Guides

Other

Thanks to all our contributors ❤️ (We use the generate-authors.sh script to regenerate this list.)
How to file a GitHub Issue

1.7 KiB Raw Blame History Unescape Escape