pepkit / pepkit/pephub

Project name shouldn't be inside the project

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

Nobody has claimed this yet.

priority low
Dominant language
TypeScript
Stars
22
Forks
2
PR merge metrics
No merged PRs in 30d

Description

Right now, the project 'name' (which is used in the registry path) is stored inside the project itself in the config file.

This leads to confusion, like when I try to paste a local PEP in and it lacks the 'name' field. It's not immediately obvious that 'name' mean the name of the repo.

Analogy to a git repo: it's as if the name of the repo was somehow stored inside the repository. This is unnatural. In the future we should change this.

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 does not name any files, tests, or entry points. First trace how the project name is read from config and how the registry path is built, then clarify the intended external source and migration behavior. Done should mean projects no longer require the name inside their own config while registry lookup remains correct.

Written by the indexing model from the issue text.

Assessment

Domain
backend-api-design
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.