Changes between Version 9 and Version 10 of ContributingCode
- Timestamp:
- 01/11/08 07:05:16 (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
ContributingCode
v9 v10 5 5 == General Guidelines for Submitting Code == 6 6 7 In general, Subversion works best if you do a separate commits for each change; don't bundle up several modifications into one commit al. Above all else, make sure that you include a commit message that contains enough information to make sense when read in the context of Trac's 'Timeline' view. This is really important - a blank commit message forces other developers to check through your changes in detail to figure out what has changed.7 In general, Subversion works best if you do a separate commits for each change; don't bundle up several modifications into one commit. Above all else, make sure that you include a commit message that contains enough information to make sense when read in the context of Trac's 'Timeline' view. This is really important - a blank commit message forces other developers to check through your changes in detail to figure out what has changed. If you are committing to a subproject of TiddlyWiki then it is useful if you prefix the commit message with the "subproject:" so that the commit is easily identified. 8 8 9 9 == Guidelines for Core Code Contributors == … … 19 19 * Impractical to offer as a plugin 20 20 * Use the same CodingConventions as the existing core code. Even if your preferred conventions are better... 21 * Test the change on all major browsers 21 * Test the change on all major browsers (Internet Explorer, Firefox, Opera and Safari) 22 22 23 23 == Creating a patch == … … 39 39 Plugins are specially treated by the [wiki:Cook] process enabling them to be stored in human readable form (as opposed to ordinary tiddlers which are somewhat obfuscated by the {{{\n}}} escaping and so on). A plugin called {{{MyPlugin}}} is formed out of up to three separate files: 40 40 41 * {{{MyPlugin.js}}} is the text of the plugin41 * {{{MyPlugin.js}}} is the body of the plugin with code and documentation - see "Guidelines for Plugin Documentation, below 42 42 * {{{MyPlugin.deps}}} references any dependent tiddlers or plugins that should be automatically cooked along with this plugin (it uses the same syntax as RecipeFiles) 43 43 * {{{MyPlugin.js.meta}}} is a text file containing the metadata about the plugin (see below)
