Improve how to contribute and review expectations

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

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation

Research direction

Review the existing contribution and review guidance, including the survey feedback linked in the issue. Clarify who reviews requests, how review is requested, and how the separate events and filter definitions repository affects the PR and version-bump process; done means these expectations are documented and discoverable.

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:

The most confusing part for me was figuring out WHO should be reviewing requests? Or if there was a process for requesting a review. Otherwise, I found documentation to be very helpful. My biggest complaint, last time I was working in these repos the documentation was still in PRs and a WIP, but it contained a lot of useful and important info. Hopefully those PRs made their way into being merged at this point to help discoverability.

The events and filter definitions are in a separate repo and that always creates some friction with PRs since you have a multi-step process of merging and bumping versions based on another pr.

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.