|
| 1 | +.. |
| 2 | + # ******************************************************************************* |
| 3 | + # Copyright (c) 2024 Contributors to the Eclipse Foundation |
| 4 | + # |
| 5 | + # See the NOTICE file(s) distributed with this work for additional |
| 6 | + # information regarding copyright ownership. |
| 7 | + # |
| 8 | + # This program and the accompanying materials are made available under the |
| 9 | + # terms of the Apache License Version 2.0 which is available at |
| 10 | + # https://www.apache.org/licenses/LICENSE-2.0 |
| 11 | + # |
| 12 | + # SPDX-License-Identifier: Apache-2.0 |
| 13 | + # ******************************************************************************* |
| 14 | +
|
| 15 | + |
| 16 | +Feature Request Guideline |
| 17 | +############################## |
| 18 | + |
| 19 | +.. document:: Feature Request Guideline |
| 20 | + :id: doc__feature_request_guideline |
| 21 | + :status: valid |
| 22 | + |
| 23 | +This Feature Request Guideline is a "How-To for Dummies" for proposing/contributing a new feature or changes to an existing feature. |
| 24 | +This Guideline is based on or references following documents: |
| 25 | +* :ref:`Contribution Guideline <contribute_contribution_guideline>` |
| 26 | +* :ref:`Change Management Plan <change_mgmt_plan>` |
| 27 | +* :ref:`Feature Template <chm_feature_templates>` |
| 28 | + |
| 29 | +Creation of Feature Request |
| 30 | +================================ |
| 31 | +* As the very first step, you will need to become of an official contributor, as described in |
| 32 | + `Actions to Ensure Proper Contribution <https://eclipse-score.github.io/score/main/contribute/general/contribution_attribution.html#contribution-attribution>`_ |
| 33 | +* Afterwards you will be able to create a GitHub Issue and mark it |
| 34 | + |
| 35 | + * with label *feature_request* if you want to propose a new feature, or |
| 36 | + * with label *feature_modification* if you want to propose changes to an existing feature. |
| 37 | + |
| 38 | + as described in *Change Management Plan*. |
| 39 | + |
| 40 | +* Technical Leads review regulary all new incoming feature requests (GitHub Issues labeled as *feature_request* or *feature_modification*). This happens normally on Monday in the Technical Lead cirle. |
| 41 | + As soon as you've labeled your GitHub Issue with *feature request*/*feature_modification* label, TLs will see the *feature request* and will add it to the special GitHub project, |
| 42 | + `Feature Request GitHub Project <https://github.com/orgs/eclipse-score/projects/4>`_. Inside of *Feature Request GitHub Project* we use additional states for a better tracking of the *feature request*. |
| 43 | + These states symbolizes the status of the *feature request* and not the "GitHub" states of the issue. The initial status of every *feature request* will be set to "Draft". |
| 44 | +* Next step would be to start working on the *feature request*. First of all, change the status of *Feature Request* into "in Progress" state. |
| 45 | + *Feature Requests*, that stay in the status "Draft" for a longer period of time, will be deleted. Depending on the maturity of the *feature request*, following two options are possible: |
| 46 | + |
| 47 | + * If the *feature request* is "just an idea" and you do not have any concrete requirements, |
| 48 | + feature architecture diagramms or source code, then you could put the description of you *feature request* directly to the description of the *GitHub Issue*. |
| 49 | + A good exhaustive description is a prerequisite for feature request to be accepted. |
| 50 | + * If you already have some requirements, feature architecture description or code, then you could create a PR in the `score repository <https://github.com/eclipse-score/score/tree/main/docs/features>`_ |
| 51 | + with your proposal. The PR should follow following template: :ref:`Feature Template <chm_feature_templates>`. |
| 52 | + |
| 53 | +Review of Feature Request |
| 54 | +================================ |
| 55 | +* As soon as you're done with description of your *feature request*, please put the status into "Ready for Review" so that Technical Leads know, that they can starting with the process of reviewing the *feature request*. |
| 56 | + Technical Leads will do a short review of your *feature request*: |
| 57 | + |
| 58 | + * In case the impact of your *feature request* is trivial, then TLs can process your *feature request* immediately. |
| 59 | + * Normally, TL circle will assign it to the lead of appropriate *CFT* or *Community* for better analysis. This team will change the status to "in Review" as soon as they will start |
| 60 | + reviewing your *feature request*. |
| 61 | + |
| 62 | + * In case a *feature request* can not be clearely assigned to any already existing team, Technical Lead circle will pick at least two suitable candidates from the project to review the *feature request*. |
| 63 | + |
| 64 | + * In case of big architectural impact, Technical Lead cirlce can additionally decide to request a review from software architecture community. |
| 65 | + |
| 66 | +* The outcome of the review could be like following: |
| 67 | + |
| 68 | + * **Accepted** - You *feature request* is accepted. Your PR will be merged and the Issue will be closed. The technical leads will create a new GitHub issue of type 'Epic', |
| 69 | + where detailed information regarding your feature will be documented. Afterwards the epic will be assigned to the corresponding team (CFT/Community). |
| 70 | + If none of the CFTs/Communities match the new *feature request*, then a new CFT/Community will be founded. You will be invited to the CFT/Community for break down of the *feature request* and planning. |
| 71 | + * **Rejected** - You *feature request* was rejected. It could be either because you description was not mature enough or because the proposal technically doesn't fit into S-CORE roadmap or architecture. |
| 72 | + You will be able to find the result of the review in the corresponding GitHub issue comments. |
| 73 | + * **Changes Requested** - We like your idea, but we would like to request some modifications. This could be rather technical topics or also syntax issues in the description. |
| 74 | + You will find all necessary information in GitHub Issue comments. |
| 75 | + * **POC needed** - We generally like your idea but we don't have enough technical understanding of the feature request, e.g. technical scope is too big, and we need a POC to be able to understand better, |
| 76 | + how the proposed *feature request* fits into the overall solution. You will find in the GitHub issue comments the information what your POC should focus on. |
| 77 | + Also a so called *incubation repository* will be created by the reviewers of the *feature request*, where you should implement your POC. |
| 78 | + Please be aware, that POC is not a guarantee, that you *feature request* will be accepted. |
0 commit comments