| Table of Contents |
|---|
| Info |
|---|
The purpose of an OpenMBEE Enhancement Proposal (OEP) is to introduce any major change to OpenMBEE. This is required in order to balance the need to support new features, use cases, while avoiding accidentally introducing half thought-out interfaces that cause needless problems when changed. |
What is considered a major change that needs an OEP?
Any of the following should be considered a major change:
...
What are the "public interfaces" of the project? All of the following are public interfaces that people build around:
TODO
Proposal lifecycle
| Info |
|---|
Prerequisites
If you have trouble accessing any of the above, please contact openmbee [at] gmail [dot] com |
Discuss
Most proposals start with an idea. If you have an idea of how OpenMBEE could improve, we encourage you to send an email to openmbee [at] googlegroups [dot] com with a subject starting with [DISCUSS]. This email thread will allow you to gather early feedback. We encourage you to start a Draft document on this wiki or share a Google Document with the mailing list detailing your proposal. Use the OEP template to provide details on your proposal.
Draft
Anyone is welcome to propose a new improvement to OpenMBEE. You will need to request edit access to the Confluence page in order to create your OEP document. You can do so by sending an email with details to openmbee [at] gmail [dot] com and request permission.
| Create from Template | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Vote
Once you or someone else feels like there’s a rough consensus on the idea and there’s no strong opposition, you can move your proposal to the Vote phase. For this you will send a new email to openmbee [at] googlegroups [dot] com with the subject starting with [VOTE]. In your [VOTE] email please include links to
...
If you want to introduce significant changes to your proposal after it has been accepted you can do so following the same procedure.
Accepted
Congratulations! Your proposal has been accepted. Next up is breaking down tasks. You should break down tasks on one or more of the OpenMBEE repository issue trackers. You are strongly advised to group the tasks together in a Github Project if it consists of multiple steps and you want to be able to track progress for its implementation or share the progress with others. Once issues are created, it helps if you can tag them with the relevant OEP-Xlabel for your OEP. If you need help with this then you can contact an existing OpenMBEE developer.
Now you can start contributing and - more importantly - you can, and probably should, encourage others to contribute to your project. However this is optional and up to your discretion. Again, you can learn how to contribute and communicate by reading the Contributing guide in the OpenMBEE GitHub Organization. Use your imagination and various communication channels for ways to encourage people if you do not already have contributors following your idea. It is advisable that several people work on the OEP so that the knowledge is shared.
Completed
You should move your OEP to complete after you consider the main bulk of work has been merged to the repository. It is okay to leave open issues for minor follow up tasks like adding additional capabilities or similar.
Abandoned
An OEP may be moved to abandoned if there has been no owner or intention of developing it further for over a year or if the owner decides to abandon it. The latter can happen if the creator decides to refactor one OEP into a new OEP for example or if there is a proposal that supersedes the original OEP.
Acknowledgements/Credits
This guide is adapted from the https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals created by the Apache Airflow community. Kudos!
OEP Maintenance
This documents relevance, utility and maintenance is a responsibility shared by all OpenMBEE community members. If you see something wrong, or you wish to propose changes, then please do so by getting in touch with the community.