Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Linux Tools Project/New Subproject Checklist"
Line 5: | Line 5: | ||
* Properly hide internal classes in internal packages | * Properly hide internal classes in internal packages | ||
* View, editor and so on ids in plugin.xml should be in the form "org.eclipse.linuxtools.*" | * View, editor and so on ids in plugin.xml should be in the form "org.eclipse.linuxtools.*" | ||
− | * | + | * Public source code should be commented with proper javadoc. Project settings should be setup to warn developers about that. |
* Project's [http://eclipse.org/linuxtools/ web site] should be enhanced by a new section for the subproject. | * Project's [http://eclipse.org/linuxtools/ web site] should be enhanced by a new section for the subproject. | ||
* End user documentation should be written in Eclipse wiki [[Linux_Tools_Project/User_Guides]]. Even non end user visible subprojects should have documentation describing it's usage. | * End user documentation should be written in Eclipse wiki [[Linux_Tools_Project/User_Guides]]. Even non end user visible subprojects should have documentation describing it's usage. | ||
− | * Each sub-project should have a doc plugin generated from the wiki page using | + | * Each sub-project should have a doc plugin generated from the wiki page using [[Mylyn/Extensions#WikiText_.28by_EclipseMylyn.29 Mylyn WikiText]]. |
* Bugzilla component for the given subproject should be added. | * Bugzilla component for the given subproject should be added. |
Revision as of 11:14, 10 January 2011
{{#eclipseproject:technology.linux-distros}}
Linux Tools | |
Website | |
Download | |
Community | |
Mailing List • Forums • IRC • mattermost | |
Issues | |
Open • Help Wanted • Bug Day | |
Contribute | |
Browse Source |
- Java package names should start with org.eclipse.linuxtools.<subproject>
- Properly hide internal classes in internal packages
- View, editor and so on ids in plugin.xml should be in the form "org.eclipse.linuxtools.*"
- Public source code should be commented with proper javadoc. Project settings should be setup to warn developers about that.
- Project's web site should be enhanced by a new section for the subproject.
- End user documentation should be written in Eclipse wiki Linux_Tools_Project/User_Guides. Even non end user visible subprojects should have documentation describing it's usage.
- Each sub-project should have a doc plugin generated from the wiki page using Mylyn/Extensions#WikiText_.28by_EclipseMylyn.29 Mylyn WikiText.
- Bugzilla component for the given subproject should be added.