manifoldco / manifoldco/torus-cli

Standardize usage of username and fullname / email throughout

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

Nobody has claimed this yet.

good first issue
Dominant language
Go
Stars
603
Forks
30
PR merge metrics
No merged PRs in 30d

Description

We reference email, username, and full name throughout but we're not consistent about where they are used and when.

Let's come up with a simple guide line for when we use each one and how we refer to them. For instance, in the path we refer to `identity`, but this is a username or machine name. Other places, we use the full name and username.

If we could standardize, it'd be easier for a user to grok the system.

Contributor guide

Open the contributing guide

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 does not identify files, tests, or entry points. First inventory how email, username, full name, and identity are currently named and used across the project, then agree on terminology and document the resulting guidance. Done means the usage rules are explicit and consistently applied throughout the system.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
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.