readthedocs/readthedocs.org

Use a named tuple for tags and branches data

Open

#7,798 opened on Jan 5, 2021

View on GitHub
 (5 comments) (1 reaction) (0 assignees)Python (3,748 forks)batch import
AcceptedGood First IssueImprovement

Repository metrics

Stars
 (7,765 stars)
PR merge metrics
 (Avg merge 10d 6h) (44 merged PRs in 30d)

Description

We are passing a list of dictionaries with verbose_name and identifier, we should use a data structure for this instead to avoid bugs. We need to make sure that celery can serialize named tuples.

ref https://github.com/readthedocs/readthedocs.org/pull/7548#discussion_r542636920

Contributor guide

Research direction
Explore how to replace the list of dictionaries with a named tuple and verify that Celery can serialize it. Look at the linked PR discussion for context.
Tech stack
python
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65