libp2p / libp2p/go-libp2p

Rethink overriding defaults in the constructors

Open
#409 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/enhancement
Dominant language
Go
Stars
6.9k
Forks
1.3k
Avg merge
13d 21h
Merged PRs (30d)
1

Description

Currently, when adding a new transport, we *replace* the defaults. Instead, we may want to consider:

1. Adding an option to clear the defaults.
2. Extending them by default (instead of replacing).

This has bitten us a few times when we decide to *enable* something but end up *disabling* the defaults because we forget to specify them.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the transport constructors and where their defaults are replaced; the issue names no files or tests, so first map those entry points. Compare the two proposed option semantics with existing transport behavior. Done requires an agreed default and clear behavior, followed by implementation and tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
networking
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.