AI Badges Framework

• Overview
• Installation
  • Prerequisites
  • Installation
  • Usage
  • Setting Up Development Environment
  • Code Standards
  • Architecture Decisions
• Contributing
• References
• License
• Maintainer

Overview

Installation

Prerequisites

Installation

Usage

Setting Up Development Environment

TBD when the tutor plugin PR is merged.

Code Standards

• All code, comments, and documentation must be in clear, concise English
• Write descriptive commit messages using conventional commits.
• Follow the CI instructions on code quality.

Architecture Decisions

Significant architectural decisions are documented in ADRs (Architectural Decision Records) located in the docs/decisions/ directory.

Contributing

We welcome contributions! This is an experimental project exploring AI integration patterns for Open edX.

How to Contribute:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/your-feature)
3. Make your changes following the code standards
4. Write or update tests as needed
5. Submit a pull request with a clear description

For questions or discussions, please use the Open edX discussion forum.

References

• Open edX Plugin Development

License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). See the LICENSE file for details.

Maintainer

This repository is covered by the Open edX maintainers program and the current maintainers are listed in the catalog-info.yaml file.

Community Support:

• Open edX Forum: https://discuss.openedx.org
• GitHub Issues

Note: As this is an experimental project, support is provided on a best-effort basis.