BGPCEP M4 readout
[docs.git] / docs / release-process / milestone-readouts / m4_template.rst
1 .. Instructions
2 ..    1. Replace Project Name with your actual project name, ensure you have
3 ..       the same number of ='s as the length of your project in the line before
4 ..       and the line after.
5 ..    2. Remove the (Yes/No) answer at the end of each question with your actual
6 ..       response: Yes or No
7 ..       Note: For Question 5, the response could be: No Deliverables
8 ..    3. For detailed information on each question, use a sub list with a -
9 ..       in front that aligns with the text above and ensure you have a blank
10 ..       line before it.
11 ..
12
13 ============
14 Project Name
15 ============
16
17 1. Do you have any previously-incomplete items from prior milestone
18    readouts? (Yes/No)
19
20 2. Has your project met code freeze [1]_? (Yes/No)
21
22 3. Are all externally visible strings frozen to allow for translation &
23    documentation? (Yes/No)
24
25 4. Is your documentation complete [2]_? (Yes/No)
26
27    - (For each document, link to the file in gerrit)
28    - (Link to pending gerrit patches waiting approval)
29
30 5. Were project-specific deliverables planned for this milestone delivered
31    successfully? (No Deliverables/Yes/No)
32
33 6. Are you running at least one basic automated system test job for each
34    top-level feature? (Yes/No)
35
36    - (If yes, link to test report)
37    - (If not, explain why)
38
39 7. Do you have any CLM violations? (Yes/No)
40
41    - (If yes, list your CLM violations and explain why each violation can be exempt)
42
43 **Stable Features (Only for Projects with Stable Features)**
44
45 A. Do your stable features fulfill quality requirements [3]_? (Yes/No)
46
47    - (If yes, link to sonar report)
48    - (If not, explain why)
49
50 B. Are you running several automated system test jobs [4]_ for each stable
51    feature? (Yes/No)
52
53    - (If yes, link to test reports)
54    - (If not, explain why)
55
56 .. [1] Only bug fixes are allowed from now on
57 .. [2] Only editing and enhancing should take place from now on
58 .. [3] Unit and/or integration test coverage of at least 75%
59 .. [4] These test jobs include functionality, cluster, scalability, performance,
60        longevity/stability