review.md 3.91 KB
Newer Older
Wayne Beaton's avatar
Wayne Beaton committed
1
2
3
4
5
<!--
There's help in the Eclipse Foundation Project Handbook https://www.eclipse.org/projects/handbook/#release-review

Parts of this issue can initially be left blank to be filled in during the review.

Wayne Beaton's avatar
Wayne Beaton committed
6
7
Set the title of this issue to the project's id, e.g., "technology.dash"

Wayne Beaton's avatar
Wayne Beaton committed
8
9
10
You can delete the comments (or not).
-->

Wayne Beaton's avatar
Wayne Beaton committed
11
12
The EMO is using this issue to track this progress review. Help regarding the process can be found in the [Eclipse Foundation Project Handbook](https://www.eclipse.org/projects/handbook/#release-review).

Wayne Beaton's avatar
Wayne Beaton committed
13
14
15
16
## Project

[{Project Name}]({pmi link})

17
18
19
20
21
22
##What now?
If you have doubts about the Eclipse Development process, we suggest you read this paragraph of the Eclipse Handbook on Progress and Release Reviews: https://www.eclipse.org/projects/handbook/#release-review
<!--
Being this a specification project, you'll also need to follow some extra guidelnes, ususally you'll need to run a Specification Committee Ballot before the release review date. Please make sure to check your Working group guidelines regarding Specification releases.
-->

Maria Teresa Delgado's avatar
Maria Teresa Delgado committed
23
24
25
26
27
## Pre-requisites
- [ ] [IP log submitted]({IPzilla link})
- [ ] [PMC approval requested]({mailing list message link})
<!--
Only for specification projects
Maria Teresa Delgado's avatar
Maria Teresa Delgado committed
28
- [ ] [WG ballot initiated]({mailing list message link})
Maria Teresa Delgado's avatar
Maria Teresa Delgado committed
29
30
-->

Wayne Beaton's avatar
Wayne Beaton committed
31
## Intellectual Property Management
Wayne Beaton's avatar
Wayne Beaton committed
32

Wayne Beaton's avatar
Wayne Beaton committed
33
34
_To be completed by the EMO._

Maria Teresa Delgado's avatar
Maria Teresa Delgado committed
35
36
37
38
39
40
- [ ] All project code has [copyright and license headers](https://www.eclipse.org/projects/handbook/#ip-copyright-headers) correctly applied. ** EMO will scan the code at their discretion **
- [ ] All distributed third-party content has been vetted by the IP Due Diligence process (i.e., IP Log has been approved)

## Open Source Rules of Engagement

_To be completed by the PMC in the case of Progress Reviews._
Wayne Beaton's avatar
Wayne Beaton committed
41

Maria Teresa Delgado's avatar
Maria Teresa Delgado committed
42
43
- [ ] PMC approval [on the mailing list]({link to the message})

Wayne Beaton's avatar
Wayne Beaton committed
44
45
46
47
48
General:

- [ ] Project is operating within the mission and scope defined in its top-level project’s charter
- [ ] Project is operating within the bounds of its own scope
- [ ] Project is operating in an open and transparent manner
Maria Teresa Delgado's avatar
Maria Teresa Delgado committed
49
- [ ] Overall the project is operating according to the Eclipse Development Process. 
Wayne Beaton's avatar
Wayne Beaton committed
50

Maria Teresa Delgado's avatar
Maria Teresa Delgado committed
51
52
53
54
55
56
Things to check:
  - Communication channels advertised
  - Advertised communication channels used
  - Committers are responding to questions
  - Committers are responding to issues
  - Committers are responding to pull/merge/review requests
Wayne Beaton's avatar
Wayne Beaton committed
57
58
59

## Branding and Trademarks

Wayne Beaton's avatar
Wayne Beaton committed
60
61
_To be completed by the EMO and PMC._

Maria Teresa Delgado's avatar
Maria Teresa Delgado committed
62
The following applies when the project has a custom website.
Wayne Beaton's avatar
Wayne Beaton committed
63

Maria Teresa Delgado's avatar
Maria Teresa Delgado committed
64
To the best of our knowledge:
Wayne Beaton's avatar
Wayne Beaton committed
65
66
67
- [ ] Project content correctly uses Eclipse Foundation trademarks
- [ ] Project content (code and documentation) does not violate trademarks owned by other organizations

Maria Teresa Delgado's avatar
Maria Teresa Delgado committed
68
69
70
71
Things to check:
- Project website uses the project's formal name in first and all prominent references
- Project website includes a trademark attribution statement
- Project website footers contain all [necessary elements](https://www.eclipse.org/projects/handbook/#trademarks-website-footer)
Wayne Beaton's avatar
Wayne Beaton committed
72

Maria Teresa Delgado's avatar
Maria Teresa Delgado committed
73
## Legal Documentation
Wayne Beaton's avatar
Wayne Beaton committed
74

Maria Teresa Delgado's avatar
Maria Teresa Delgado committed
75
Required files:
Wayne Beaton's avatar
Wayne Beaton committed
76
77
78
79

- [ ] License files in all repository roots
- [ ] README
- [ ] CONTRIBUTING (or equivalent)
Maria Teresa Delgado's avatar
Maria Teresa Delgado committed
80
81
82

Recommended files: 

Wayne Beaton's avatar
Wayne Beaton committed
83
84
85
86
87
88
89
- [ ] NOTICES (or equivalent)
- [ ] CODE_OF_CONDUCT
- [ ] SECURITY

Required elements:

- [ ] ECA is referenced/described
Maria Teresa Delgado's avatar
Maria Teresa Delgado committed
90
91
92

Recommended elements: 

Wayne Beaton's avatar
Wayne Beaton committed
93
- [ ] Build instructions provided
Maria Teresa Delgado's avatar
Maria Teresa Delgado committed
94
- [ ] Security policy is described
Wayne Beaton's avatar
Wayne Beaton committed
95

Maria Teresa Delgado's avatar
Maria Teresa Delgado committed
96
## Metadata (PMI)
Wayne Beaton's avatar
Wayne Beaton committed
97

Wayne Beaton's avatar
Wayne Beaton committed
98
99
_To be completed by the EMO and PMC._

Wayne Beaton's avatar
Wayne Beaton committed
100
101
- [ ] The formal name, e.g. "Eclipse Foo™", is used in the project title
- [ ] The formal name including appropriate marks (e.g, "™") is used in the first mention in the text of the project description, and scope
Wayne Beaton's avatar
Wayne Beaton committed
102
103
104
105
106
- [ ] The project description starts with a single paragraph that can serve as an executive summary
- [ ] Source code repository references are up-to-date
- [ ] Download links and information are up-to-date

<!-- Quick actions will configure the state of the issue. Leave these. -->
Wayne Beaton's avatar
Wayne Beaton committed
107
/label ~"Review Request"
108
/assign @wbeaton @mdelgado624