From NeOn Wiki
- Please download the latest stable executable version of NTK from NTK_2.3_Pre-Release
- Does the plugin work exactly as it is supposed to work?
- Are all the names and version numbers correct?
- Does the feature contain licence agreements etc.? If not, please send them to email@example.com
- Feel free to ask if something could be changed or improved!
A list of plugins and associated reviewers is available. The review should consider the following dimensions:
- Installation: is the plugin findable/installable?
- Functionality: does the plugin work as expected? Is the plugin functional?
- Usability: is the plugin functionality easily accessible? Does the user interaction make sense?
- Documentation: is the plugin documentation available using the Eclipse Help function?
- Integration: do the plugins integrate with gOntt and Kali-ma?
To facilitate accessibility, please:
- do not use windows.showView as only way to start a functionality
- do not use openPerspective as only way to start a functionality
- do not use global toolbar icons for plugin-specific functionality
- use context menu for Project or Ontology where appropriate
- adapt your plugins to how user interface actions are implemented in NTK Core
Appendix : General Guidance for reference
(taken from NeOn Quality Assurance Plan):
Basic principles for software development
Each developer will be asked to follow the principles and demonstrate how they have done in the documentation of their software. The 3 basic principles are: readability, testability, traceability. These are elaborated in Quality Plans D11.2.1 and D11.2.3 available on the Collab.
Software Downloads - general
A software download is considered to be an electronic file available in various forms (incl. compressed or executable, or web-based).
Primary the author(s) and then WP leader where the product has been produced Downloads need to be checked for the completeness, virus safety and stability.
The main rule applying to the software downloads is to distribute it in a form and shape that does not unnecessarily expose the user’s computer to the virus or any other security hazards. This means that if the software bundle contains an executable, this has to be explicitly checked for known viruses and the result of the anti-virus control shall be made explicit during the installation and/or at the download site.
Furthermore, each software download has to be accompanied by a comprehensible README (or any other form of instructions) detailing: (i) what components are need for a correct operation of the system; (ii) what prerequisite are necessary – if any; (iii) how to carry out the download, installation and setup of the product; and (iv) where more information on the product can be obtained – incl. help lines, public forums, mailing lists, etc. According to section 2.7.1, software is a form of “Information” and as such will require a statement about responsibilities and liabilities of the NeOn Consortium to third parties. Templates for liability statements will be prepared by the software developers and owners and their organisations. These statements should form an integral part of the software licence.
Software bug reporting and fixing
The NeOn-Toolkit website employs Bugzilla to enable users to submit bugs. The bug management is restricted to components of the toolkit that are provided by the NeOn consortium. This explicitly excludes 3rd party plugins, which are expected to provide their own bug management. Bugzilla allows managing bugs by products and components. The basic configuration of Bugzilla for the toolkit is as follows: All components are grouped under one main product NeOn Toolkit. The basic idea is that every plugin is mapped to one component in order to ease the assignment and management of bugs. As such, each partner is responsible for the component corresponding to his plugin. In addition, there exists one component for the Core Toolkit and one component for the Documentation.
Legal and licensing issues
The NeOn recommended licence for plugins is EPL – this is to facilitate compatibility with the NeOn Toolkit and other plugins.
Material produced within NeOn may include information, software and/or media (individually and collectively the "Information"). The Information is made available by the NeOn Consortium and its partner organizations. Our goal is to keep this information timely and accurate. If errors are brought to our attention, we will try to correct them in line with the recommendations contained in the Quality Assurance Plan.
However, NeOn Consortium may accept no responsibility or liability whatsoever with regard to the Information. This Information is:
- not a professional or legal advice (if you need specific advice, you should always consult a suitably qualified professional)
- sometimes linked to external sites over which the NeOn Consortium has no control and for which it assumes no responsibility
- not necessarily comprehensive, complete, accurate or up to date
INCLUDE A DISCLAIMER AS APPROPRIATE e.g.: Except where otherwise noted, all Information produced by NeOn should be subject to a copyright notice or acknowledgement, for example: © NeOn: Lifecycle Support for Networked Ontologies (all rights reserved)
ACKNOWLEDGEMENT OF NEON FUNDING:
This development has been partially supported by the NeOn project (http://www.neon-project.org) and the xxxxxxxx projects, using grants from the European Commission (& xxxxxx).
S/W MUST INCLUDE THE NEON LOGO WHICH IS AVAILABLE FROM THE OU.