How to implement filters with long term support

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

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by reviewing the community survey feedback linked in the issue and the repository’s existing documentation for filters and events. Define what design decisions need guidance and document a repeatable process for creating filters with long-term support; the work is done when contributors can use that guidance to structure new filters.

Written by the indexing model from the issue text.

Description

documentation

Description

Some comments I've gathered from the community survey on the challenges/suggestions section:

Each event/filter needs to be well thought out with a longish term support so how to structure it can be a heavy decision .

How can we document this better to make the design process easier?

Dominant language
Python
Stars
10
Forks
30
Avg merge
5h 49m
Merged PRs (30d)
5

Getting set up

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.

More from openedx/openedx-filters

All issues in openedx/openedx-filters

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.