1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-06-23 13:53:15 +00:00

Docs updates

This commit is contained in:
Jermolene 2014-10-16 10:01:02 +01:00
parent a4c1fee075
commit 209c018c38
4 changed files with 42 additions and 0 deletions

View File

@ -16,6 +16,9 @@ Welcome to the developer documentation for TiddlyWiki (http://tiddlywiki.com/).
** [[TiddlyWiki on node-webkit]]
** [[package.json for node-webkit]]
** [[How to create plugins in the browser]]
** [[Contributing to the TiddlyWiki Core]]
** [[Contributing to the TiddlyWiki Plugin Library]]
** [[Scripts for building tiddlywiki.com]]
** SyncAdaptorModules
** WidgetModules
** WikiRuleModules

View File

@ -0,0 +1,22 @@
created: 20141016083308219
modified: 20141016083333808
title: Contributing to the TiddlyWiki Core
type: text/vnd.tiddlywiki
The TiddlyWiki core is the container for all the generic features of TiddlyWiki that are of universal utility. Concretely, it comprises the tiddlers in the `$:/core` plugin.
! Core Contribution Requirements
There are requirements that must be met for any contribution that is to be accepted into the core:
* If appropriate, the new functionality must support both standalone and Node.js configurations. For example, any new widgets must be capable of being rendered on the server
* The contribution must not compromise the backwards compatibility of the existing code
* Code contributions must comply with the [[TiddlyWiki Coding Style Guidelines]]
* Generic components are preferred over point solutions for specific problems (which belong in plugins)
! The Core and Innovation
If you've created something new and innovative, don't try to rush to get it included into the core. Once new stuff is in the core it is subject to the core policies of strict backwards compatibility, making it frozen as far as radical innovation is concerned. It's usually better to release the new thing as a plugin so that it can be shared with the rest of the community for feedback.
The expected model of innovation is that the core development will move relatively slowly as more and more of the initial planned functionality is implemented. Innovation can take place in the much more unconstrained environment of plugins. Over time, as these third party plugins gain popularity and become more polished, some or all of their functionality will be migrated into the core.

View File

@ -0,0 +1,14 @@
created: 20141016083308219
modified: 20141016083333808
title: Contributing to the TiddlyWiki Plugin Library
type: text/vnd.tiddlywiki
The TiddlyWiki Plugin library is the set of plugins, themes and languages that are distributed via http://tiddlywiki.com.
The plugin library is intended to help end users of TiddlyWiki in the following ways:
* By being a reliable, official source of community assets
* Permitting automatic upgrading of plugins during the upgrade process
* Providing a guarantee of backwards compatibility
Plugins in the library need a maintainer who is prepared to make a commitment to keep them tested and fully operational with successive releases of the core code. Many plugins are maintained by the core team.

View File

@ -1,3 +1,4 @@
modified: 20141016083333808
title: TiddlyWiki Coding Style Guidelines
tags: dev
@ -7,6 +8,8 @@ TiddlyWiki is a large project with many interested parties. It benefits everyone
! Guidelines
This list of guidelines isn't exhaustive but captures some of the common problems. The ultimate guide is the existing TiddlyWiki code-base. There are still some places where the coding guidelines aren't used consistently within the core; pull requests are welcome to help resolve those issues.
!! Tabs and whitespace
TiddlyWiki uses 4-character tabs for indenting.