Here we focus on contributions via GitHub Pull Requests but there are many other ways that anyone can help the TiddlyWiki project, such as reporting bugs or helping to improve our documentation.
PRs must meet these minimum requirements before they can be considered for merging:
The "imperative mood" means written as if giving a command or instruction. See this post for more details, but the gist is that the title of the PR should make sense when used to complete the sentence "If applied, this commit will...". So for example, these are good PR titles:
These a poorly worded PR titles:
PR titles may also include a short prefix to indicate the subsystem to which they apply. For example:
One of the principles of open source is that many pairs of eyes on the code can improve quality. So, we welcome comments and critiques of pending PRs. Conventional Comments has some techniques to help make comments as constructive and actionable as possible. Notably, they recommend prefixing a comment with a label to clarify the intention:
| praise | Praises highlight something positive. Try to leave at least one of these comments per review. Do not leave false praise (which can actually be damaging). Do look for something to sincerely praise |
| nitpick | Nitpicks are small, trivial, but necessary changes. Distinguishing nitpick comments significantly helps direct the reader's attention to comments requiring more involvement |
| suggestion | Suggestions are specific requests to improve the subject under review. It is assumed that we all want to do what's best, so these comments are never dismissed as “mere suggestions”, but are taken seriously |
| issue | Issues represent user-facing problems. If possible, it's great to follow this kind of comment with a suggestion |
| question | Questions are appropriate if you have a potential concern but are not quite sure if it's relevant or not. Asking the author for clarification or investigation can lead to a quick resolution |
| thought | Thoughts represent an idea that popped up from reviewing. These comments are non-blocking by nature, but they are extremely valuable and can lead to more focused initiatives and mentoring opportunities |
| chore | Chores are simple tasks that must be done before the subject can be “officially” accepted. Usually, these comments reference some common process. Try to leave a link to the process description so that the reader knows how to resolve the chore |
Like other OpenSource projects, TiddlyWiki5 needs a signed contributor license agreement from individual contributors. This is a legal agreement that allows contributors to assert that they own the copyright of their contribution, and that they agree to license it to the UnaMesa Association (the legal entity that owns TiddlyWiki on behalf of the community).
Create a GitHub pull request to add your name to cla-individual.md or cla-entity.md, with the date in the format (YYYY/MM/DD).
step by step
tiddlywiki-comJeremy Ruston, @Jermolene, 2011/11/22The CLA documents used for this project were created using Harmony Project Templates. "HA-CLA-I-LIST Version 1.0" for "CLA-individual" and "HA-CLA-E-LIST Version 1.0" for "CLA-entity". +
Here we focus on contributions via GitHub Pull Requests but there are many other ways that anyone can help the TiddlyWiki project, such as reporting bugs or helping to improve our documentation.
PRs must meet these minimum requirements before they can be considered for merging:
The "imperative mood" means written as if giving a command or instruction. See this post for more details, but the gist is that the title of the PR should make sense when used to complete the sentence "If applied, this commit will...". So for example, these are good PR titles:
These a poorly worded PR titles:
PR titles may also include a short prefix to indicate the subsystem to which they apply. For example:
One of the principles of open source is that many pairs of eyes on the code can improve quality. So, we welcome comments and critiques of pending PRs. Conventional Comments has some techniques to help make comments as constructive and actionable as possible. Notably, they recommend prefixing a comment with a label to clarify the intention:
| praise | Praises highlight something positive. Try to leave at least one of these comments per review. Do not leave false praise (which can actually be damaging). Do look for something to sincerely praise |
| nitpick | Nitpicks are small, trivial, but necessary changes. Distinguishing nitpick comments significantly helps direct the reader's attention to comments requiring more involvement |
| suggestion | Suggestions are specific requests to improve the subject under review. It is assumed that we all want to do what's best, so these comments are never dismissed as “mere suggestions”, but are taken seriously |
| issue | Issues represent user-facing problems. If possible, it's great to follow this kind of comment with a suggestion |
| question | Questions are appropriate if you have a potential concern but are not quite sure if it's relevant or not. Asking the author for clarification or investigation can lead to a quick resolution |
| thought | Thoughts represent an idea that popped up from reviewing. These comments are non-blocking by nature, but they are extremely valuable and can lead to more focused initiatives and mentoring opportunities |
| chore | Chores are simple tasks that must be done before the subject can be “officially” accepted. Usually, these comments reference some common process. Try to leave a link to the process description so that the reader knows how to resolve the chore |
Like other OpenSource projects, TiddlyWiki5 needs a signed contributor license agreement from individual contributors. This is a legal agreement that allows contributors to assert that they own the copyright of their contribution, and that they agree to license it to the UnaMesa Association (the legal entity that owns TiddlyWiki on behalf of the community).
Create a GitHub pull request to add your name to cla-individual.md or cla-entity.md, with the date in the format (YYYY/MM/DD).
step by step
tiddlywiki-comJeremy Ruston, @Jermolene, 2011/11/22The CLA documents used for this project were created using Harmony Project Templates. "HA-CLA-I-LIST Version 1.0" for "CLA-individual" and "HA-CLA-E-LIST Version 1.0" for "CLA-entity".
This file was automatically generated by TiddlyWiki5
\ No newline at end of file diff --git a/core/modules/savers/put.js b/core/modules/savers/put.js index de9ba9465..a1ebef4bb 100644 --- a/core/modules/savers/put.js +++ b/core/modules/savers/put.js @@ -48,7 +48,7 @@ var PutSaver = function(wiki) { var self = this; var uri = this.uri(); // Async server probe. Until probe finishes, save will fail fast - // See also https://github.com/Jermolene/TiddlyWiki5/issues/2276 + // See also https://github.com/TiddlyWiki/TiddlyWiki5/issues/2276 $tw.utils.httpRequest({ url: uri, type: "OPTIONS", diff --git a/languages/pl-PL/readme.md b/languages/pl-PL/readme.md index daeff0408..a3edc7526 100644 --- a/languages/pl-PL/readme.md +++ b/languages/pl-PL/readme.md @@ -1 +1 @@ -Translation notes are available here: https://github.com/Jermolene/TiddlyWiki5/discussions/6080 \ No newline at end of file +Translation notes are available here: https://github.com/TiddlyWiki/TiddlyWiki5/discussions/6080 \ No newline at end of file diff --git a/package.json b/package.json index ed1b7f5d8..4dbd39087 100644 --- a/package.json +++ b/package.json @@ -16,7 +16,7 @@ "main": "./boot/boot.js", "repository": { "type": "git", - "url": "https://github.com/Jermolene/TiddlyWiki5.git" + "url": "https://github.com/TiddlyWiki/TiddlyWiki5.git" }, "keywords": [ "tiddlywiki", diff --git a/plugins/tiddlywiki/aws/docs/setup.tid b/plugins/tiddlywiki/aws/docs/setup.tid index 7a358d289..f6b710d4c 100644 --- a/plugins/tiddlywiki/aws/docs/setup.tid +++ b/plugins/tiddlywiki/aws/docs/setup.tid @@ -37,7 +37,7 @@ aws_secret_access_key = <your secret access key> Even if you have already installed TiddlyWiki, you should create a new installation for working with the AWS plugin. -Visit the TiddlyWiki5 repository at https://github.com/Jermolene/TiddlyWiki5. You can either download or clone a copy: +Visit the TiddlyWiki5 repository at https://github.com/TiddlyWiki/TiddlyWiki5. You can either download or clone a copy: * Download to get up and running quickly * Clone to make it easier to upgrade in the future diff --git a/plugins/tiddlywiki/browser-sniff/readme.tid b/plugins/tiddlywiki/browser-sniff/readme.tid index 9de5985b0..f50ca50d3 100644 --- a/plugins/tiddlywiki/browser-sniff/readme.tid +++ b/plugins/tiddlywiki/browser-sniff/readme.tid @@ -6,4 +6,4 @@ It allows you to create content that is presented in a way that is responsive to For example, https://tiddlywiki.com uses this plugin to present the user with the best options for getting started depending on their browser. -[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/browser-sniff]] +[[Source code|https://github.com/TiddlyWiki/TiddlyWiki5/blob/master/plugins/tiddlywiki/browser-sniff]] diff --git a/plugins/tiddlywiki/browser-storage/readme.tid b/plugins/tiddlywiki/browser-storage/readme.tid index 8c1360d07..9abe5eaa1 100644 --- a/plugins/tiddlywiki/browser-storage/readme.tid +++ b/plugins/tiddlywiki/browser-storage/readme.tid @@ -6,7 +6,7 @@ At startup, the plugin reads tiddlers from local storage. Any tiddlers that are !! Optional use with ~TiddlyWeb plugin -For wikis served from a ~TiddlyWeb compatible server, including the ~TiddlyWiki Node JS server, this plugin may be added to provide temporary local storage of tiddler changes when the [[tiddlyweb sync adapter|https://github.com/Jermolene/TiddlyWiki5/tree/master/plugins/tiddlywiki/tiddlyweb]] is unable to successfully synchronise with the server, and to automatically synchronise tiddlers saved offline in browser storage once connection is re-established. The use of browser storage allows for tiddlers saved offline to be synchronised with the server even in the case where the browser is closed or the user (purposely, accidentally, or automatically in the case of a mobile browser periodically refreshing) navigates away from the wiki. +For wikis served from a ~TiddlyWeb compatible server, including the ~TiddlyWiki Node JS server, this plugin may be added to provide temporary local storage of tiddler changes when the [[tiddlyweb sync adapter|https://github.com/TiddlyWiki/TiddlyWiki5/tree/master/plugins/tiddlywiki/tiddlyweb]] is unable to successfully synchronise with the server, and to automatically synchronise tiddlers saved offline in browser storage once connection is re-established. The use of browser storage allows for tiddlers saved offline to be synchronised with the server even in the case where the browser is closed or the user (purposely, accidentally, or automatically in the case of a mobile browser periodically refreshing) navigates away from the wiki. Changes will be synchronised with the server the next time the wiki is loaded in the browser. Tiddlers are removed from browser-storage once synchronised to the server. diff --git a/plugins/tiddlywiki/cecily/readme.tid b/plugins/tiddlywiki/cecily/readme.tid index 8b3179dc4..39e2e8846 100644 --- a/plugins/tiddlywiki/cecily/readme.tid +++ b/plugins/tiddlywiki/cecily/readme.tid @@ -6,4 +6,4 @@ Cecily is based on an earlier plugin for TiddlyWiki Classic: http://jermolene.co Cecily is currently in the early stages of development with little functionality yet implemented. -[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/cecily]] +[[Source code|https://github.com/TiddlyWiki/TiddlyWiki5/blob/master/plugins/tiddlywiki/cecily]] diff --git a/plugins/tiddlywiki/classictools/readme.tid b/plugins/tiddlywiki/classictools/readme.tid index d33395e1c..2ff631618 100644 --- a/plugins/tiddlywiki/classictools/readme.tid +++ b/plugins/tiddlywiki/classictools/readme.tid @@ -9,4 +9,4 @@ The additional features are: See https://github.com/TiddlyWiki/tiddlywiki.com for more details. -[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/classictools]] +[[Source code|https://github.com/TiddlyWiki/TiddlyWiki5/blob/master/plugins/tiddlywiki/classictools]] diff --git a/plugins/tiddlywiki/codemirror/readme.tid b/plugins/tiddlywiki/codemirror/readme.tid index c36e2eac0..1ac58e357 100755 --- a/plugins/tiddlywiki/codemirror/readme.tid +++ b/plugins/tiddlywiki/codemirror/readme.tid @@ -2,6 +2,6 @@ title: $:/plugins/tiddlywiki/codemirror/readme This plugin provides an enhanced text editor component based on [[CodeMirror|http://codemirror.net]]. The basic configuration is designed to be as lightweight as possible and is just around 235kb of size. Additional features can be installed with ~CodeMirror ~AddOns from the plugin library. -[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/codemirror]] +[[Source code|https://github.com/TiddlyWiki/TiddlyWiki5/blob/master/plugins/tiddlywiki/codemirror]] Based on ~CodeMirror version 5.58.3 diff --git a/plugins/tiddlywiki/consent-banner/docs.tid b/plugins/tiddlywiki/consent-banner/docs.tid index 55ef4a6b7..92f20377b 100644 --- a/plugins/tiddlywiki/consent-banner/docs.tid +++ b/plugins/tiddlywiki/consent-banner/docs.tid @@ -61,4 +61,4 @@ Third party plugins that set cookies can configure themselves to defer setting c * The consent-banner plugin includes a shadow tiddler [[$:/config/cookie-consent-required]] with the text `yes`. The third-party plugin should inspect this tiddler at startup; if it is not set to "yes" then it can proceed to set tiddlers immediately * Otherwise, the third-party plugin should listen for changes to the tiddler [[$:/state/consent-banner/accepted]] and only start setting cookies when and if the value changes to "yes" -The [[Google Analytics plugin|https://github.com/Jermolene/TiddlyWiki5/tree/master/plugins/tiddlywiki/googleanalytics]] shows an example of how this mechanism can be implemented. +The [[Google Analytics plugin|https://github.com/TiddlyWiki/TiddlyWiki5/tree/master/plugins/tiddlywiki/googleanalytics]] shows an example of how this mechanism can be implemented. diff --git a/plugins/tiddlywiki/d3/readme.tid b/plugins/tiddlywiki/d3/readme.tid index b0f0fc425..24ea2d708 100644 --- a/plugins/tiddlywiki/d3/readme.tid +++ b/plugins/tiddlywiki/d3/readme.tid @@ -4,4 +4,4 @@ The D3 plugin is a proof-of-concept demo of integration with the D3.js data visu It is not currently in a state where it can be used for anything useful. -[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/d3]] +[[Source code|https://github.com/TiddlyWiki/TiddlyWiki5/blob/master/plugins/tiddlywiki/d3]] diff --git a/plugins/tiddlywiki/filesystem/readme.tid b/plugins/tiddlywiki/filesystem/readme.tid index 3e95d58c6..a871d0510 100644 --- a/plugins/tiddlywiki/filesystem/readme.tid +++ b/plugins/tiddlywiki/filesystem/readme.tid @@ -2,4 +2,4 @@ title: $:/plugins/tiddlywiki/filesystem/readme The filesystem plugin is used under Node.js to synchronise tiddler changes back to the file system. It is inert when used in the browser. -[[Source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/filesystem]] +[[Source code|https://github.com/TiddlyWiki/TiddlyWiki5/blob/master/plugins/tiddlywiki/filesystem]] diff --git a/plugins/tiddlywiki/github-fork-ribbon/readme.tid b/plugins/tiddlywiki/github-fork-ribbon/readme.tid index 4707aaa6b..6033730b7 100644 --- a/plugins/tiddlywiki/github-fork-ribbon/readme.tid +++ b/plugins/tiddlywiki/github-fork-ribbon/readme.tid @@ -6,4 +6,4 @@ The ribbon can be positioned over any corner, and can incorporate user defined t The CSS stylesheet is adapted from work by [[Simon Whitaker|https://github.com/simonwhitaker/github-fork-ribbon-css/]] -[[Plugin source code|https://github.com/Jermolene/TiddlyWiki5/blob/master/plugins/tiddlywiki/github-fork-ribbon]] +[[Plugin source code|https://github.com/TiddlyWiki/TiddlyWiki5/blob/master/plugins/tiddlywiki/github-fork-ribbon]] diff --git a/plugins/tiddlywiki/github-fork-ribbon/template.tid b/plugins/tiddlywiki/github-fork-ribbon/template.tid index 22cee156d..b0319f929 100644 --- a/plugins/tiddlywiki/github-fork-ribbon/template.tid +++ b/plugins/tiddlywiki/github-fork-ribbon/template.tid @@ -11,7 +11,7 @@ left: offset from left in px - No ; right: offset from right in px - No ; fixed: "fixed" .. If ribbon is at the top, it can be "fixed". Bottom is always fixed --> -\parameters (position:"right", url:"https://github.com/Jermolene/TiddlyWiki5", text:"Fork me on ~GitHub" color:"#aa0000" top:"0" bottom:"0" left:"0" right:"0" fixed:"") +\parameters (position:"right", url:"https://github.com/TiddlyWiki/TiddlyWiki5", text:"Fork me on ~GitHub" color:"#aa0000" top:"0" bottom:"0" left:"0" right:"0" fixed:"")