Jetpack/Design Guidelines: Difference between revisions

no edit summary
No edit summary
No edit summary
Line 7: Line 7:
* <strike>Generative</strike>
* <strike>Generative</strike>
* The Jetpack APIs and development system for extending the browser will be made as simple as possible, as easy to learn, and as easy to maintain as possbile
* The Jetpack APIs and development system for extending the browser will be made as simple as possible, as easy to learn, and as easy to maintain as possbile
** Clear and consistant APIs -- guidelines will outline naming conventions (CamelCase?), placement and position of arguments (jquery like? options, arg, callbacks?)  
** Clear and consistent APIs -- guidelines will outline naming conventions (CamelCase?), placement and position of arguments (jquery like? options, arg, callbacks?)  
** Minimal API Set  -- Make sure we have solid use cases for each API and have reduced to common root.  
** Minimal API Set  -- Make sure we have solid use cases for each API and have reduced to common root.  
** Complete, Comprehensive & Orthogonal APIs across the full API set - find all the common attributes/arguments (add, remove, get, set) make a grid and make sure its complete.
** Complete, Comprehensive & Orthogonal APIs across the full API set - find all the common attributes/arguments (add, remove, get, set) make a grid and make sure its complete.
** Consitent Error Handling to Enable Debugging.  
** Consistent Error Handling to Enable Debugging.  
** Testing -- APIs will be implimented in test driven development process.  write the test first, then develop support for the api to pass the test.
** Testing -- APIs will be implemented in test driven development process.  write the test first, then develop support for the api to pass the test.
** Extensibility.  The goals list above all strive to keep the base set of supported APIs as minimal as possible, and then allow extensibility for creating additional experimental features.
** Extensibility.  The goals list above all strive to keep the base set of supported APIs as minimal as possible, and then allow extensibility for creating additional experimental features.
Confirmed users, Bureaucrats and Sysops emeriti
1,531

edits