This document describes the project management workflow with github used in the Edirom Online repository.
The project follows an open, community-driven development model.
Issues, discussions, and pull requests are managed through the Edirom GitHub Project Board, which provides a shared overview of progress, priorities, and upcoming releases. The Project Board manages three repositories: the main Edirom-Online, Edirom-Online-Frontend and Edirom-Online-Backend with views, that address different aspects of the software development (e.g. open PRs, next releases, assignee).
-
Issues are used to track bugs, feature requests, and documentation improvements.
-
Each issue should have:
-
Pull Requests (PRs) should:
- Reference the related issue(s)
- Follow the contributing guidelines
- Pass all automated tests and code reviews before merging
Among other actions, one custom GitHub Action ensures that all new issues and PRs are automatically added to the Edirom Online Project.
This keeps project tracking consistent and up to date without manual intervention.
- Milestones correspond to planned release versions (e.g.,
v1.0.0,v2.5.0). - Each milestone collects all issues and PRs targeted for that release.
- Before release, issues are reviewed to ensure they meet acceptance criteria.
The repository meets GitHub’s community standards, including:
- Code of Conduct
- Contributing Guidelines
- License Information
- Issue and PR Templates
These ensure transparency, accessibility, and consistency in collaboration.
The workflow and automation are regularly reviewed and refined to adapt to the needs of the development team and community contributors. Feedback is always welcome — feel free to open an issue or discussion to propose improvements.
Last updated: 2025-11-11