Skip to content

Commit 4a0b6c3

Browse files
committed
docs: fix findings in PR
Fix multiple findings in the PR
1 parent 7ab587b commit 4a0b6c3

File tree

2 files changed

+51
-32
lines changed

2 files changed

+51
-32
lines changed

docs/contribute/contribution_request/feature_request.rst

Lines changed: 49 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -29,38 +29,53 @@ This Guideline is based on or references following documents:
2929

3030
Creation of Feature Request
3131
================================
32-
* As the very first step, you will need to become of an official contributor, as described in
33-
`Actions to Ensure Proper Contribution <https://eclipse-score.github.io/score/main/contribute/general/contribution_attribution.html#contribution-attribution>`_
34-
35-
* Afterwards you will be able to create a GitHub Issue and mark it
36-
37-
* with label *feature_request* if you want to propose a new feature, or
38-
* with label *feature_modification* if you want to propose changes to an existing feature,
39-
40-
as described in the :ref:`Change Management Plan <change_mgmt_plan>`.
41-
42-
Please put a short description of your *feature request* into the GitHub Issue description, so that
43-
everyone can immediately understand, what the *feature request* is about.
44-
45-
Technical Leads review regularly all new incoming *feature requests* (GitHub Issues labeled as *feature_request* or *feature_modification*).
46-
This happens normally on Monday in the `Technical Lead circle <https://github.com/orgs/eclipse-score/discussions/104>`_.
47-
As soon as you've labeled your GitHub Issue with *feature request*/*feature_modification* label,
48-
TLs will see the *feature request* and will add it to the special GitHub project,
49-
`Feature Request GitHub Project <https://github.com/orgs/eclipse-score/projects/4>`_.
50-
Inside of this *Feature Request GitHub Project* additional states are used for a better tracking of the *feature requests*.
51-
These states symbolize the status of the *feature request* and not the "GitHub" states of the issue, therefore we will further speak about
52-
*feature request status*. The initial status of every *feature request* is set to "Draft".
53-
54-
* After you have created a GitHub Issue, next step would be to start working on the *feature request*.
55-
First of all, change the status of *Feature Request* to "in Progress" state.
56-
*Feature Requests*, that stay in the status "Draft" for a longer period of time, will be deleted.
57-
Afterwards create a PR with your proposal in the `/docs/features <https://github.com/eclipse-score/score/tree/main/docs/features>`_ score repository.
58-
There you will find currently existing features as subfolders. Please choose the one that fits your *feature request* the most or
59-
create a new subfolder, if none of existing feature match your *feature request*. Please take care, that the PR follows the :ref:`Feature Template <chm_feature_templates>`.
60-
You should try to put as much information as possible, as a good exhaustive description is a prerequisite for *feature request* to be accepted.
32+
1. As the very first step, you will need to become an official contributor, as described in
33+
`Actions to Ensure Proper Contribution <https://eclipse-score.github.io/score/main/contribute/general/contribution_attribution.html#contribution-attribution>`_
34+
35+
2. Afterwards you will be able to create a GitHub Issue in the main `score repository <https://github.com/eclipse-score>`_
36+
and mark it
37+
38+
* with label *feature_request* if you want to propose a new feature, or
39+
* with label *feature_modification* if you want to propose changes to an existing feature,
40+
41+
as described in the :ref:`Change Management Plan <change_mgmt_plan>`.
42+
43+
Please put a short description of your *feature request* into the GitHub Issue description, so that
44+
everyone can immediately understand, what the *feature request* is about.
45+
46+
Technical Leads review regularly all new incoming *feature requests* (GitHub Issues labeled as *feature_request* or *feature_modification*).
47+
This happens normally on Monday in the `Technical Lead circle <https://github.com/orgs/eclipse-score/discussions/104>`_.
48+
As soon as you've labeled your GitHub Issue with *feature request*/*feature_modification* label,
49+
TLs will see the *feature request* and will add it to the special GitHub project,
50+
`Feature Request GitHub Project <https://github.com/orgs/eclipse-score/projects/4>`_.
51+
Inside of this *Feature Request GitHub Project* additional states, as shown in the table below,
52+
are used for a better tracking of the *feature requests*.
53+
These states symbolize the status of the *feature request* and not the "GitHub" states of the issue, therefore we will further speak about
54+
*feature request status*. The initial status of every *feature request* is set to "Draft".
55+
56+
====================== ====================
57+
FR status Description
58+
====================== ====================
59+
**Draft** Feature Request is in the initial state
60+
**In Progress** This is actively being worked on
61+
**In Review** Feature Request should be reviewed by the technical leads
62+
**Accepted** Feature Request was accepted
63+
**Rejected** Feature request was rejected
64+
**Changes Requested** Changes requested
65+
**POC Needed** "Proof of concept" in incubation repository is needed
66+
====================== ====================
67+
68+
3. After you have created a GitHub Issue, next step would be to start working on the *feature request*.
69+
First of all, change the status of *Feature Request* to "in Progress" state.
70+
*Feature Requests*, that stay in the status "Draft" longer as 4 weeks, will be deleted.
71+
Afterwards create a PR with your proposal in the `/docs/features <https://github.com/eclipse-score/score/tree/main/docs/features>`_ score repository.
72+
There you will find currently existing features as subfolders. Please choose the one that fits your *feature request* the most or
73+
create a new subfolder, if none of existing feature match your *feature request*. Please take care, that the PR follows the :ref:`Feature Template <chm_feature_templates>`.
74+
You should try to put as much information as possible, as a good exhaustive description is a prerequisite for *feature request* to be accepted.
6175

6276
It is important to understand, that *feature request* consists of an GitHub Issue, that is used to track organizational information and
63-
PR, that contains the technical content. GitHub Issue always stays assigned to the owner of the *feature request*.
77+
PR, that contains the technical content. This is explained once again in detailed in the :ref:`Change Management Worlflow <change_mgmt_workflow>`
78+
chapter of :ref:`Change Management Plan <change_mgmt_plan>` document. GitHub Issue always stays assigned to the owner of the *feature request*.
6479
*Feature Request* PR will always be assigned to the owner of the *feature request* as well, but will additionally get the list of reviewers, that
6580
should review this *feature request* PR.
6681

@@ -80,7 +95,8 @@ Review of Feature Request
8095

8196
* In case of big architectural impact, Technical Lead circle can additionally decide to request a review for *feature request* PR from software architecture community.
8297

83-
* The outcome of the review could be like following:
98+
* After the review is done, the TL circle will set the status of the *feature request* accordingly and will
99+
also put all further necessary information as GitHub Issue comments. The outcome of the review could be like following:
84100

85101
* **Accepted** - You *feature request* is accepted. The *feature request* GitHub Issue should contain now a link to a new GitHub issue of type 'Epic',
86102
that was created by Technical Leads, where detailed information regarding your feature is documented.
@@ -98,6 +114,7 @@ Review of Feature Request
98114
The review comments will be done directly in the *feature request* PR.
99115
* **POC needed** - We generally like your idea, but we don't have enough technical understanding of the *feature request*,
100116
e.g. technical scope is too big, and we need a POC to be able to understand better,
101-
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.
117+
how the proposed *feature request* fits into the overall solution. You will find in the GitHub issue comments
118+
the decsription for both the scope of the PoC and the requirements and the acceptance criteria for the requested PoC.
102119
Also, a so called *incubation repository* will be created by the reviewers of the *feature request*, where you should implement your POC.
103120
Please be aware, that POC is not a guarantee, that you *feature request* will be accepted.

docs/platform_management_plan/change_management.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,8 @@ description.
141141
:need:`[[title]] <gd_req__change__attr_milestone>` is defined by the Milestone of a ISSUE.
142142

143143

144+
.. _change_mgmt_workflow:
145+
144146
Change Request Workflow
145147
^^^^^^^^^^^^^^^^^^^^^^^
146148

0 commit comments

Comments
 (0)