Skip to content

docs: Update README with criteria for new blocks #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kdmccormick wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Update README with criteria for new blocks #150

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ac18d5
docs: Update README with criteria for new blocks
kdmccormick Jan 29, 2026
821056e
docs: Clarify that the criteria is an 'and' not an 'or'
kdmccormick Jan 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
xblocks-contrib
===============

This repository is the new home for XBlocks, a core component of the Open edX ecosystem.
This project involves the extraction of XBlocks from the edx-platform.
This repository is the new home for XBlocks which are part of the base openedx-platform
installation.

Project Overview
=======================
Expand Down Expand Up @@ -34,6 +34,19 @@ The possible XBlock statuses are:
* Done The built-in block has been removed. The setup.py entrypoint has been removed from edx-platform and added to xblock-contrib.


Additional XBlocks that belong here
***********************************

Over time, more XBlocks may be moved here. An XBlock belongs here if and only if both of the following are true:

1. **It needs to be part of the out-of-the-box Open edX experience, as agreed upon by the
Product Working Group.** Otherwise, perhaps the block belongs in `xblocks-extra <https://github.com/openedx/xblocks-extra>`_,
or it belongs in a community repository outside of the openedx GitHub organization.

2. **The maintainers of this repository have capacity to maintain the additional block.**
Otherwise, perhaps the block belongs in its own repository with a separate dedicated maintainer,
such as `ora2 <https://github.com/openedx/edx-ora2>`_.

Developing a new XBlock
=======================

Expand Down