This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
project_proposals:template [2014/10/06 12:02] Christopher Price created |
project_proposals:template [2015/11/19 23:09] (current) Ildiko Vancsa [Key Project Facts] |
||
---|---|---|---|
Line 1: | Line 1: | ||
==== Project Name: ==== | ==== Project Name: ==== | ||
- | * Proposed name for the project: ''project-name'' | + | * Proposed name for the project: ''project-name'' |
- | * Proposed name for the repository: ''repo-name'' | + | * Proposed name for the repository: ''repo-name'' |
- | * Project Categories: ''(Documentation, Requirements, Integration & Testing, Collaborative Development)'' | + | |
==== Project description: ==== | ==== Project description: ==== | ||
- | * Provide high level description of intended project and OPNFV use case and benefit, if needed. | + | * Provide high level description of intended project and OPNFV use case and benefit, if needed. |
- | * Include any architecture diagrams or specifications, reference to OPNFV requirements list. | + | * Include any architecture diagrams or specifications, reference to OPNFV requirements list. |
==== Scope: ==== | ==== Scope: ==== | ||
- | * Describe the problem being solved by project | + | * Describe the problem being solved by project |
- | * Specify any interface/API specification proposed, | + | * Specify any interface/API specification proposed, |
- | * Specify testing and integration: | + | * Specify testing and integration: |
- | * Debugging and Tracing | + | * Debugging and Tracing |
- | * Unit/Integration Test plans | + | * Unit/Integration Test plans |
- | * Client tools developed for status shows etc. | + | * Client tools developed for status shows etc. |
- | * Identity a list of features and functionality will be developed. | + | * Identity a list of features and functionality will be developed. |
- | * Identify what is in or out of scope. So during the development phase, it helps reduce discussion. | + | * Identify what is in or out of scope. So during the development phase, it helps reduce discussion. |
- | * Describe how the project is extensible in future | + | * Describe how the project is extensible in future |
- | ==== Testability: ''(optional, Project Categories: Integration & Testing)'' ==== | + | ==== Testability: ==== |
- | * Specify testing and integration like interoperability, scalability, high availablity | + | * Specify testing and integration like interoperability, scalability, high availability |
- | * What QA and test resources will be available? | + | * What QA and test resources will be available? |
- | ==== Documentation: ''(optional, Project Categories: Documention)'' ==== | + | ==== Documentation: ==== |
- | * API Docs | + | * API Docs |
- | * Functional block description | + | * Functional block description |
==== Dependencies: ==== | ==== Dependencies: ==== | ||
- | * Identify similar projects is underway or being proposed in OPNFV or upstream project | + | * Identify similar projects is underway or being proposed in OPNFV or upstream project |
- | * Identify any open source upstream projects and release timeline. | + | * Identify any open source upstream projects and release timeline. |
- | * Identify any specific development be staged with respect to the upstream project and releases. | + | * Identify any specific development be staged with respect to the upstream project and releases. |
- | * Are there any external fora or standard development organization dependencies. If possible, list and informative and normative reference specifications. | + | * Are there any external fora or standard development organization dependencies. If possible, list and informative and normative reference specifications. |
- | * If project is an integration and test, identify hardware dependency. | + | * If project is an integration and test, identify hardware dependency. |
==== Committers and Contributors: ==== | ==== Committers and Contributors: ==== | ||
- | * Name of and affiliation of the maintainer | + | * Names and affiliations of the committers |
- | * Names and affiliations of the committers | + | * Names and affiliations of any other contributors |
- | * Any other contributors | + | |
- | ==== Planned deliverables ==== | + | ==== Planned deliverables: ==== |
- | * Described the project release package as OPNFV or open source upstream projects. | + | * Described the project release package as OPNFV or open source upstream projects. |
- | * If project deliverables have multiple dependencies across other project categories, described linkage of the deliverables. | + | * If project deliverables have multiple dependencies across other project categories, described linkage of the deliverables. |
==== Proposed Release Schedule: ==== | ==== Proposed Release Schedule: ==== | ||
- | * When is the first release planned? | + | * When is the first release planned? |
- | * Will this align with the current release cadence | + | * Will this align with the current release cadence |
+ | |||
+ | |||
+ | Use the above information to create a key project facts section on your project page | ||
+ | ===== Key Project Facts ===== | ||
+ | |||
+ | ** Project Name: ** Project Name (repo name) \\ | ||
+ | ** Repo name: ** \\ | ||
+ | ** Lifecycle State: ** \\ | ||
+ | ** Primary Contact: ** \\ | ||
+ | ** Project Lead: ** \\ | ||
+ | ** Jira Project Name: ** Same as Project name \\ | ||
+ | ** Jira Project Prefix: ** [10 Characters max [A-Z] ] \\ | ||
+ | ** mailing list tag ** [Should match Jira Project Prefix] \\ | ||
+ | ** Committers: ** \\ | ||
+ | foo@bar.com \\ | ||
+ | baz@qux.com \\ | ||
+ | ** Link to TSC approval: Example http://meetbot.opnfv.org/meetings/opnfv-meeting/2015/opnfv-meeting.2015-03-03-15.01.html ** \\ | ||
+ | ** Link to approval of additional submitters: ** Example http://meetbot.opnfv.org/meetings/opnfv-meeting/2015/opnfv-meeting.2015-03-03-15.01.html \\ | ||