openedx / openedx/openedx-platform

Too many console warnings

Open
#32,888 10 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

epic help wanted maintenance
Dominant language
Python
Stars
8.2k
Forks
4.4k
Avg merge
6d 18h
Merged PRs (30d)
42

Description

Many warnings routinely get logged when doing console operations in edx-platform. This is especially visible when provisioning a devstack installation (although the problem isn't limited to devstack). These warnings often indicate latent problems with the code that will cause headaches when attempting future upgrades, they distract developers when looking for the root cause of a problem, and some cause a disproportionate amount of log clutter because they reappear every time a management command is called. We should clean up as many of these as practical to improve the developer experience when working with the repository.

A/C:

  • Enumerate all the warnings that appear when provisioning lms & cms in devstack (ideally also noting the number of times each one appears).
  • Create a separate GitHub Issue in this repository to resolve each warning. They should get the "maintenance" and "help wanted" labels.
  • Create a tasklist in this issue collecting all the created issues.
Tasks

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 with recent lms and cms provisioning logs from the devstack provisioning-tests workflow and enumerate warnings originating in edx-platform, recording their frequency. For each warning, create a maintenance/help-wanted issue in the relevant repository and add its link to this issue's tasklist. Done means the edx-platform warnings are catalogued and the resulting issues are collected here.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
developer-experience
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.