paritytech / paritytech/polkadot-cli

Align encoding/decoding flag naming and strategy

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

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
10
Forks
2
Avg merge
12h 35m
Merged PRs (30d)
4

Description

Problem

The current --encoded flag feels off — it reads as a description of state rather than an action. --encode would be more natural as a directive ("encode the output").

Questions to resolve

  • Naming: Rename --encoded--encode across all commands that use it
  • Decoding: How should decoding be supported? A --decode flag? A dedicated dot decode command? Both?
  • Subcommand vs flag: Related to #12 — should encoding/decoding be subcommands (dot tx encode ..., dot tx decode ...) rather than flags? This might compose better and be clearer in intent.

Related

  • #12 — Replace --encode with encode command?

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

The issue names no files or tests. Start by locating every command that uses --encoded, then read related issue #12 to understand the proposed command structure. Done means reaching a decided, documented interface for encoding and decoding and identifying all affected commands.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.