zulip/zulip

Contribute Zulip's JsonableError framework to Django upstream

Open

#975 opened on Jun 7, 2016

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (7,339 forks)batch import
area: dependencieshelp wanted

Repository metrics

Stars
 (19,672 stars)
PR merge metrics
 (Avg merge 36d 6h) (110 merged PRs in 30d)

Description

Zulip has this nice JsonableError framework (defined in zerver/lib/request.py plus zerver/middleware.py) that can turn an exception thrown inside Zulip into a nice user-facing error message for all of our JSON routes. I think this would be a great feature to contribute to Django upstream, since it would help a lot of other developers as well. I talked to a Django core team member at PyCon, and he thought it would be a great addition but probably deserves a thread on the django-devel mailing list to make sure we get the right interface merged into mainline.

(We'd want to generalize this a bit to support other ways to marshall the data, and maybe think a bit more about making internationalization really nice, but I think this would be a great small contribution.)

Contributor guide

Research direction
Understand Django's exception handling and JSON responses. Draft a proposal for the django devel mailing list. Consider internationalization and generalization.
Tech stack
pythondjango
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
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.
Clear
Prerequisites
PythonDjangoGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70