mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-27 18:40:28 +00:00
Code Issues Releases Wiki Activity

Add contributing guidelines

Browse Source
This commit is contained in:
Jeremy Ruston 2013-07-02 08:38:00 +01:00
parent df997e024c
commit 81b4ca7347
5 changed files with 70 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
bld.sh
View File

@ -36,6 +36,7 @@ node ./tiddlywiki.js \
./editions/tw5.com \
--verbose \
--savetiddler ReadMe ./readme.md text/html \
--savetiddler ContributingTemplate ./contributing.md text/html \
--savetiddler $:/core/templates/tiddlywiki5.template.html $TW5_BUILD_OUTPUT/index.html text/plain \
--savetiddler $:/core/templates/static.template.html $TW5_BUILD_OUTPUT/static.html text/plain \
--savetiddler $:/core/templates/static.template.css $TW5_BUILD_OUTPUT/static/static.css text/plain \

34
contributing.md Normal file
View File

@ -0,0 +1,34 @@
<h1 class=''>
Contributing to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
TiddlyWiki5</a></h1><div class='tw-transclude'>
<p>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
TiddlyWiki5</a> welcomes contributions to its code and documentation <a class='tw-tiddlylink tw-tiddlylink-external' href='https://github.com/Jermolene/TiddlyWiki5'>
via GitHub</a>. Please take a moment to read these notes to help make the process as smooth as possible.</p><h1 class=''>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='http://five.tiddlywiki.com/static/Bug%20Reports.html'>
https://github.com/Jermolene/TiddlyWiki5/issues?state=open</a></h1><p>
From a programmers perspective, a bug report that just says &quot;it doesn't work&quot; is highly frustrating. For effective debugging, we need as much information as possible. At a minimum, please ensure that you 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><p>
<a class='tw-tiddlylink tw-tiddlylink-external' href='http://mhay68.tumblr.com/post/1648223018/what-makes-a-good-bug-report'>
http://mhay68.tumblr.com/post/1648223018/what-makes-a-good-bug-report</a>
<a class='tw-tiddlylink tw-tiddlylink-external' href='http://www.chiark.greenend.org.uk/~sgtatham/bugs.html'>
http://www.chiark.greenend.org.uk/~sgtatham/bugs.html</a></p><h1 class=''>
Pull Requests</h1><p>
Like other <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/OpenSource.html'>
OpenSource</a> projects, <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
TiddlyWiki5</a> needs a signed <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='http://five.tiddlywiki.com/static/ContributorLicenseAgreement.html'>
ContributorLicenseAgreement</a> from individual contributors before contributions of code can be accepted.</p><p>
<em>
As of July 2013, <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
TiddlyWiki5</a> does not yet have the necessary infrastructure to permit CLAs to be signed and retained.</em>
</p></div><p>
<em>
This file was automatically generated by <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
TiddlyWiki5</a></em>
</p>

25
editions/tw5.com/tiddlers/Contributing.tid Normal file
View File

@ -0,0 +1,25 @@
modified: 201307020736
title: Contributing
TiddlyWiki5 welcomes contributions to its code and documentation [[via GitHub|https://github.com/Jermolene/TiddlyWiki5]]. Please take a moment to read these notes to help make the process as smooth as possible.
! [[Bug Reports|https://github.com/Jermolene/TiddlyWiki5/issues?state=open]]
From a programmers perspective, a bug report that just says "it doesn't work" is highly frustrating. For effective debugging, we need as much information as possible. At a minimum, please ensure that you include:
* A descriptive title
* A summary
* Steps to reproduce
* Expected behaviour
* Context (OS, browser etc.)
There's a lot of good material on the web about bug reports:
http://mhay68.tumblr.com/post/1648223018/what-makes-a-good-bug-report
http://www.chiark.greenend.org.uk/~sgtatham/bugs.html
! Pull Requests
Like other OpenSource projects, TiddlyWiki5 needs a signed ContributorLicenseAgreement from individual contributors before contributions of code can be accepted.
//As of July 2013, TiddlyWiki5 does not yet have the necessary infrastructure to permit CLAs to be signed and retained.//

2
editions/tw5.com/tiddlers/HelpingTiddlyWiki.tid
View File

@ -22,6 +22,6 @@ There's lively discussion about TiddlyWiki in the Google Groups:
! 4. Improve the Documentation and Code
The main TiddlyWiki documentation and code lives on GitHub, and so can be forked and pulled freely:
The main TiddlyWiki documentation and code lives on GitHub, and welcomes [[contributions||Contributing]]:
https://github.com/Jermolene/TiddlyWiki5

9
editions/tw5.com/tiddlers/readme/ContributingTemplate.tid Normal file
View File

@ -0,0 +1,9 @@
title: ContributingTemplate
tags: introduction
\define tw-wikilink-template() http://five.tiddlywiki.com/static/$uri_encoded$.html
! Contributing to TiddlyWiki5
{{Contributing}}
//This file was automatically generated by TiddlyWiki5//