openedx / openedx/openedx-filters
Improve how to contribute and review expectations
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:
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.
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
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.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100