|
| 1 | +## Table of Contents |
| 2 | +- [Introduction](#introduction) |
| 3 | +- [Process Overview](#process-overview) |
| 4 | + |
| 5 | +## Introduction |
| 6 | + |
| 7 | +Welcome to MONAI Deploy! This documentation is intended for individuals and institutions interested in contributing to the MONAI Deploy project. We expect contributions in three main areas: |
| 8 | + |
| 9 | +1. **Guideline**: Guideline and Design proposals |
| 10 | +2. **Feature**: Code and Implementation |
| 11 | +3. **Community**: Improving community processes and procedures |
| 12 | + |
| 13 | +## Process Overview |
| 14 | + |
| 15 | +1. Create an issue |
| 16 | + * Mention in the ticket if you think it’s [Guideline, Feature, Community]. |
| 17 | + * Use the MONAI Deploy template for your issue |
| 18 | + |
| 19 | +2. Categorise an issue |
| 20 | + |
| 21 | + * The issue creator should add initial issue labels, if they can. |
| 22 | + * MONAI Deploy release manager for that release will categorize the issue or correct it. |
| 23 | + * If an issue has overlap between multiple categories [Guideline, Feature, Community], the issue needs to be broken down into smaller issues |
| 24 | + |
| 25 | +3. Gain approval to develop large proposals |
| 26 | + |
| 27 | + * For larger ideas of improvement for MONAI Deploy, the release manager will bring it up for discussion at the weekly working group meeting. |
| 28 | + * Small issues, bug fixes and non-controversial features get picked up and prioritized for implementation |
| 29 | + |
| 30 | +4. Develop proposal/feature |
| 31 | + |
| 32 | + * If successful consensus is found, develop the work and open a pull request. |
| 33 | + * Any written markdown documents should follow [rfc 2119](https://datatracker.ietf.org/doc/html/rfc2119). |
| 34 | + * For **Feature** development, please follow the main MONAI contributing [guidelines](https://github.com/Project-MONAI/MONAI/blob/dev/CONTRIBUTING.md) |
| 35 | + |
| 36 | +5. Feedback and approval |
| 37 | + |
| 38 | + * There will be a feedback period to allow offline review. The default period is 2 weeks, however shorter or longer periods can be granted at the discretion of the working group. |
| 39 | + * The proposal gets reviewed offline, comments and decisions get documented as part of the pull request, so the community can read and understand key decisions. |
| 40 | + * Once a proposal is mature enough, it is presented again at the working group meeting. |
| 41 | + * Once working group approves the proposal, the Pull Request is merged into the main branch |
0 commit comments