openedx / openedx/openedx-filters
How to create a filter from start to finish
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 10
- Forks
- 28
- Avg merge
- 3d 8h
- Merged PRs (30d)
- 8
Description
Description
Some comments I've gathered from the community survey on the challenges/suggestions section:
I would only improve the documentation a little bit. For example, in the section on creating a filter it talks about two different filters, which may cause confusion. I think it would be good to show an example of a filter implemented from start to finish, which contains all or at least most of the functionality offered by the library. additionally, the openedx-filters-samples repository has a great variety of examples, but it shows the filter creation part, but not (I think) the filter usage which is also important.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing documentation section on creating a filter and review the examples in the openedx-filters-samples repository. Document one filter from creation through usage, covering as much of the library's functionality as the example supports; done means the guide is understandable without switching between conflicting filter examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100