This repository is the central place for non-code resources that govern and support the AReaL ecosystem. If you are looking for source code, documentation, or examples of AReaL itself, please visit the main repository at areal-project/AReaL.
| Document | Purpose |
|---|---|
| GOVERNANCE.md | Governing principles, decision-making, and how the project is run. |
| COMMUNITY_LADDER.md | Contributor roles (Contributor, Member, Approver, Maintainer). |
| COMMUNITY_MEMBERSHIP.md | Elections, promotions, departures, and membership processes. |
| roles/ | The people who currently hold each community role. |
| CODE_OF_CONDUCT.md | Community standards based on Contributor Covenant 3.0. |
| CONTRIBUTING.md | How to contribute to the community (events, docs, translations, etc.). |
| SECURITY.md | How to responsibly disclose security vulnerabilities. |
| REPOSITORIES.md | Index of repositories that make up the AReaL ecosystem. |
| ROADMAP.md | Pointer to the official AReaL project roadmap. |
| LICENSE | Apache License 2.0, under which AReaL is released. |
There are many ways to participate, regardless of your background:
- Ask or answer questions in GitHub Discussions.
- Report issues or propose features in the main issue tracker.
- Improve documentation, translations, or examples in the main repository.
- Join community meetings. AReaL holds regular community calls; meeting notes and recordings are linked from the main project's community materials.
See CONTRIBUTING.md for more details.
AReaL's collaboration happens in the open. The main ways to reach the community are:
- GitHub Issues -- bug reports, feature requests, and proposals in the main issue tracker.
- GitHub Discussions -- questions, ideas, and open-ended discussion in AReaL Discussions.
- Community meetings -- regular community calls. Agendas, slides, and recordings are indexed in meeting/README.md.
- Security reports -- private disclosure channels described in SECURITY.md.
The project is governed as described in GOVERNANCE.md. AReaL is a community-driven project with a four-rung contributor ladder -- Contributor, Member, Approver, and Maintainer -- described in COMMUNITY_LADDER.md. The decision-making process, election and promotion procedures, and the people who hold each role are documented in COMMUNITY_MEMBERSHIP.md and under roles/.
We welcome your feedback. Share product ideas in
Discussions, raise governance or
community-process feedback in an issue labeled governance in this repository or at a
community meeting. See GOVERNANCE.md for details.
All content in this repository is licensed under the Apache License 2.0, the same license used by the main AReaL project.