TiddlyWiki5/contributing.md

<h1 class=''>
Contributing to <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
TiddlyWiki5</a></h1><p>
<a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
TiddlyWiki5</a> welcomes contributions to its code and documentation via <a href='https://github.com/Jermolene/TiddlyWiki5' target='_blank'>
GitHub</a>. Please take a moment to read these notes to help make the process as smooth as possible.</p><h2 class=''>
Bug Reports</h2><p>
From the perspective of the developers, a bug report that says little more than &quot;it doesn't work&quot; can be frustrating. For effective debugging, we need as much information as possible. At a minimum, please try to include:</p><ul>
<li>
A descriptive title</li><li>
A summary</li><li>
Steps to reproduce</li><li>
Expected behaviour</li><li>
Context (OS, browser etc.)</li></ul><p>
There's a lot of good material on the web about bug reports:</p><ul>
<li>
<a href='http://mhay68.tumblr.com/post/1648223018/what-makes-a-good-bug-report' target='_blank'>
http://mhay68.tumblr.com/post/1648223018/what-makes-a-good-bug-report</a></li><li>
<a href='http://www.chiark.greenend.org.uk/~sgtatham/bugs.html' target='_blank'>
http://www.chiark.greenend.org.uk/~sgtatham/bugs.html</a></li></ul><h2 class=''>
Pull Requests</h2><p>
Like other <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/OpenSource.html'>
OpenSource</a> projects, <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
TiddlyWiki5</a> needs a signed <a class=' tw-tiddlylink tw-tiddlylink-missing' href='http://five.tiddlywiki.com/static/ContributorLicenseAgreement.html'>
ContributorLicenseAgreement</a> from individual contributors before contributions of code can be accepted. 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 <a class=' tw-tiddlylink tw-tiddlylink-missing' href='http://five.tiddlywiki.com/static/UnaMesa.html'>
UnaMesa</a> Association (the legal entity that owns <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>
TiddlyWiki</a> on behalf of the community).</p><ul>
<li>
For individuals use: <a href='https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-individual.md' target='_blank'>
CLA-individual</a></li><li>
For entities use: <a href='https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-entity.md' target='_blank'>
CLA-entity</a></li></ul><p>
<em>
This is a first pass at a CLA for <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>
TiddlyWiki</a>. Please let us know if we missed something important. If we do have to make essential changes to the CLA, there is a possibility that all contributors will need to sign it again</em></p><h3 class=''>
How to sign the CLA</h3><pre>
git clone https://github.com/Jermolene/TiddlyWiki5.git TiddlyWiki5
cd TiddlyWiki5
git checkout -b sign-cla</pre><p>
<strong>
Add your name and the date to cla-individual.md or cla-entity.md</strong>. Date format (YYYY/MM/DD)
eg: <code>
Jeremy Ruston, @Jermolene, 2011/11/22</code></p><pre>
git add .
git commit -m &quot;sign contributor license agreement&quot;
git push origin sign-cla</pre><p>
<strong>
Go to your github repo and create a pull request.</strong></p><p>
<strong>
Thank you!</strong></p><h4 class=''>
Attribution</h4><p>
The CLA documents used for this project where created using <a href='http://www.harmonyagreements.org' target='_blank'>
Harmony Project Templates</a>. &quot;HA-CLA-I-LIST Version 1.0&quot; for &quot;CLA-individual&quot; and &quot;HA-CLA-E-LIST Version 1.0&quot; for &quot;CLA-entity&quot;
</p><p>
<em>
This file was automatically generated by <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
TiddlyWiki5</a></em>
</p>
Add contributing guidelines 2013-07-02 07:38:00 +00:00			`<h1 class=''>`
Content updates 2013-10-21 17:33:31 +00:00			`Contributing to <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>`
Start building the static files There's a few parts that don't work yet 2013-10-18 14:20:33 +00:00			`TiddlyWiki5</a></h1><p>`
Content updates 2013-10-21 17:33:31 +00:00			`<a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>`
Get external links working again We no longer use the `<$link>` widget for external links. Instead the parser generates `<a>` elements. This makes things simpler, but does mean that the `target=_blank` behaviour is baked into the parser. Probably we should introduce a new `<$extlink>` widget that generates an `<a>` element with a configurable `target` attribute 2013-10-24 10:54:54 +00:00			`TiddlyWiki5</a> welcomes contributions to its code and documentation via <a href='https://github.com/Jermolene/TiddlyWiki5' target='_blank'>`
Rebuilt contributing.md 2013-09-21 16:49:20 +00:00			`GitHub</a>. Please take a moment to read these notes to help make the process as smooth as possible.</p><h2 class=''>`
			`Bug Reports</h2><p>`
Revise contributors documentation 2013-09-27 15:15:55 +00:00			`From the perspective of the developers, a bug report that says little more than "it doesn't work" can be frustrating. For effective debugging, we need as much information as possible. At a minimum, please try to include:</p><ul>`
Add contributing guidelines 2013-07-02 07:38:00 +00:00			`<li>`
			`A descriptive title</li><li>`
			`A summary</li><li>`
			`Steps to reproduce</li><li>`
			`Expected behaviour</li><li>`
			`Context (OS, browser etc.)</li></ul><p>`
Put links in a list for readability 2013-09-22 08:54:52 +00:00			`There's a lot of good material on the web about bug reports:</p><ul>`
			`<li>`
Get external links working again We no longer use the `<$link>` widget for external links. Instead the parser generates `<a>` elements. This makes things simpler, but does mean that the `target=_blank` behaviour is baked into the parser. Probably we should introduce a new `<$extlink>` widget that generates an `<a>` element with a configurable `target` attribute 2013-10-24 10:54:54 +00:00			`<a href='http://mhay68.tumblr.com/post/1648223018/what-makes-a-good-bug-report' target='_blank'>`
Put links in a list for readability 2013-09-22 08:54:52 +00:00			`http://mhay68.tumblr.com/post/1648223018/what-makes-a-good-bug-report</a></li><li>`
Get external links working again We no longer use the `<$link>` widget for external links. Instead the parser generates `<a>` elements. This makes things simpler, but does mean that the `target=_blank` behaviour is baked into the parser. Probably we should introduce a new `<$extlink>` widget that generates an `<a>` element with a configurable `target` attribute 2013-10-24 10:54:54 +00:00			`<a href='http://www.chiark.greenend.org.uk/~sgtatham/bugs.html' target='_blank'>`
Put links in a list for readability 2013-09-22 08:54:52 +00:00			`http://www.chiark.greenend.org.uk/~sgtatham/bugs.html</a></li></ul><h2 class=''>`
Rebuilt contributing.md 2013-09-21 16:49:20 +00:00			`Pull Requests</h2><p>`
Content updates 2013-10-21 17:33:31 +00:00			`Like other <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/OpenSource.html'>`
			`OpenSource</a> projects, <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>`
			`TiddlyWiki5</a> needs a signed <a class=' tw-tiddlylink tw-tiddlylink-missing' href='http://five.tiddlywiki.com/static/ContributorLicenseAgreement.html'>`
			`ContributorLicenseAgreement</a> from individual contributors before contributions of code can be accepted. 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 <a class=' tw-tiddlylink tw-tiddlylink-missing' href='http://five.tiddlywiki.com/static/UnaMesa.html'>`
			`UnaMesa</a> Association (the legal entity that owns <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>`
A bit more explanation of why CLAs are required 2013-09-22 08:51:16 +00:00			`TiddlyWiki</a> on behalf of the community).</p><ul>`
Rebuilt contributing.md 2013-09-21 16:49:20 +00:00			`<li>`
Get external links working again We no longer use the `<$link>` widget for external links. Instead the parser generates `<a>` elements. This makes things simpler, but does mean that the `target=_blank` behaviour is baked into the parser. Probably we should introduce a new `<$extlink>` widget that generates an `<a>` element with a configurable `target` attribute 2013-10-24 10:54:54 +00:00			`For individuals use: <a href='https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-individual.md' target='_blank'>`
Rebuilt contributing.md 2013-09-21 16:49:20 +00:00			`CLA-individual</a></li><li>`
Get external links working again We no longer use the `<$link>` widget for external links. Instead the parser generates `<a>` elements. This makes things simpler, but does mean that the `target=_blank` behaviour is baked into the parser. Probably we should introduce a new `<$extlink>` widget that generates an `<a>` element with a configurable `target` attribute 2013-10-24 10:54:54 +00:00			`For entities use: <a href='https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-entity.md' target='_blank'>`
Minor rewording of contributing tiddler 2013-09-21 17:04:22 +00:00			`CLA-entity</a></li></ul><p>`
			`<em>`
Content updates 2013-10-21 17:33:31 +00:00			`This is a first pass at a CLA for <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>`
Minor rewording of contributing tiddler 2013-09-21 17:04:22 +00:00			`TiddlyWiki</a>. Please let us know if we missed something important. If we do have to make essential changes to the CLA, there is a possibility that all contributors will need to sign it again</em></p><h3 class=''>`
Rebuilt contributing.md 2013-09-21 16:49:20 +00:00			`How to sign the CLA</h3><pre>`
			`git clone https://github.com/Jermolene/TiddlyWiki5.git TiddlyWiki5`
			`cd TiddlyWiki5`
			`git checkout -b sign-cla</pre><p>`
			`<strong>`
			`Add your name and the date to cla-individual.md or cla-entity.md</strong>. Date format (YYYY/MM/DD)`
			`eg: <code>`
Minor rewording of contributing tiddler 2013-09-21 17:04:22 +00:00			`Jeremy Ruston, @Jermolene, 2011/11/22</code></p><pre>`
Rebuilt contributing.md 2013-09-21 16:49:20 +00:00			`git add .`
			`git commit -m "sign contributor license agreement"`
			`git push origin sign-cla</pre><p>`
			`<strong>`
Minor rewording of contributing tiddler 2013-09-21 17:04:22 +00:00			`Go to your github repo and create a pull request.</strong></p><p>`
Rebuilt contributing.md 2013-09-21 16:49:20 +00:00			`<strong>`
			`Thank you!</strong></p><h4 class=''>`
			`Attribution</h4><p>`
Get external links working again We no longer use the `<$link>` widget for external links. Instead the parser generates `<a>` elements. This makes things simpler, but does mean that the `target=_blank` behaviour is baked into the parser. Probably we should introduce a new `<$extlink>` widget that generates an `<a>` element with a configurable `target` attribute 2013-10-24 10:54:54 +00:00			`The CLA documents used for this project where created using <a href='http://www.harmonyagreements.org' target='_blank'>`
Rebuilt contributing.md 2013-09-21 16:49:20 +00:00			`Harmony Project Templates</a>. "HA-CLA-I-LIST Version 1.0" for "CLA-individual" and "HA-CLA-E-LIST Version 1.0" for "CLA-entity"`
Start building the static files There's a few parts that don't work yet 2013-10-18 14:20:33 +00:00			`</p><p>`
Add contributing guidelines 2013-07-02 07:38:00 +00:00			`<em>`
Content updates 2013-10-21 17:33:31 +00:00			`This file was automatically generated by <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>`
Add contributing guidelines 2013-07-02 07:38:00 +00:00			`TiddlyWiki5</a></em>`
			`</p>`