plone / plone/plone.api

Rename 'username' to 'login'?

Open
#270 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
101
Forks
62
Avg merge
15h 15m
Merged PRs (30d)
1

Description

In issue #204 @jensens proposed renaming 'username' to 'login' to differentiate more between the username/email and the userid.
I've done some work on https://github.com/plone/plone.api/compare/204_username_to_login already. This branch also contains some work by @cewing, which should be ignored for this issue.

Tasks:

  • rename username -> login
  • what do we do with the 'email' parameter?

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

Start by reading issue #204 and reviewing the existing comparison branch linked in this issue, while ignoring the work attributed to @cewing. Trace the API references to username, login, and email; done means the rename scope is agreed, username is consistently replaced where intended, and the email parameter decision is resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.