libp2p / libp2p/specs

rename "Test Extension"

Open
#703 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
1.8k
Forks
320
Avg merge
11d 15h
Merged PRs (30d)
1

Description

“Test Extension” is unfortunately named:

  • file names for this extension become confusing, e.g. test_test_extension or test_extension_test, regardless of the chosen naming convention.
  • files that implement this extension (e.g. test_extension, test_extension_types ) imply that these are test files, not actual implementation files.
  • even though this extension can be used for testing (or may be intended for interoperability testing), the “test” prefix is still misleading. an extension’s name should describe what the extension is, not who, where, or how it is used.
  • if the extension name is used without the word “extension”, it becomes unclear what is being referenced. for example, “partial messages” does not require the word “extension”, because it is already clear that it refers to an extension (assuming prior familiarity).

better name suggestion:

  • Hola - personal opinion: non english word makes better sense as name of extension (this is not my first language)
  • Hello
  • HolaInterop - if we need to have where this is used
  • HelloInterop
  • HelloOnce - because it sends "Hello" message once
  • "Experimetal" + "Hola/Hello/HelloOnce"
  • etc...

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 reviewing the issue's rationale and the existing uses of “Test Extension” referenced there. Compare the proposed replacement names and determine the intended name before identifying every affected reference. Done means the project has agreed on a replacement and the naming is updated consistently.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, networking
Issue type
Refactor
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.