From 81b4ca73476843b2532352e8a6e33aebdced7bd8 Mon Sep 17 00:00:00 2001 From: Jeremy Ruston Date: Tue, 2 Jul 2013 08:38:00 +0100 Subject: [PATCH] Add contributing guidelines --- bld.sh | 1 + contributing.md | 34 +++++++++++++++++++ editions/tw5.com/tiddlers/Contributing.tid | 25 ++++++++++++++ .../tw5.com/tiddlers/HelpingTiddlyWiki.tid | 2 +- .../tiddlers/readme/ContributingTemplate.tid | 9 +++++ 5 files changed, 70 insertions(+), 1 deletion(-) create mode 100644 contributing.md create mode 100644 editions/tw5.com/tiddlers/Contributing.tid create mode 100644 editions/tw5.com/tiddlers/readme/ContributingTemplate.tid diff --git a/bld.sh b/bld.sh index 2a9d4d797..cc385144c 100755 --- a/bld.sh +++ b/bld.sh @@ -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 \ diff --git a/contributing.md b/contributing.md new file mode 100644 index 000000000..bae3b2dff --- /dev/null +++ b/contributing.md @@ -0,0 +1,34 @@ +

+Contributing to +TiddlyWiki5

+

+ +TiddlyWiki5 welcomes contributions to its code and documentation +via GitHub. Please take a moment to read these notes to help make the process as smooth as possible.

+ +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:

+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. +

+ +This file was automatically generated by +TiddlyWiki5 +

\ No newline at end of file diff --git a/editions/tw5.com/tiddlers/Contributing.tid b/editions/tw5.com/tiddlers/Contributing.tid new file mode 100644 index 000000000..390c67b98 --- /dev/null +++ b/editions/tw5.com/tiddlers/Contributing.tid @@ -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.// diff --git a/editions/tw5.com/tiddlers/HelpingTiddlyWiki.tid b/editions/tw5.com/tiddlers/HelpingTiddlyWiki.tid index 55f6a3960..7c2742d85 100644 --- a/editions/tw5.com/tiddlers/HelpingTiddlyWiki.tid +++ b/editions/tw5.com/tiddlers/HelpingTiddlyWiki.tid @@ -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 diff --git a/editions/tw5.com/tiddlers/readme/ContributingTemplate.tid b/editions/tw5.com/tiddlers/readme/ContributingTemplate.tid new file mode 100644 index 000000000..fcb1b3b57 --- /dev/null +++ b/editions/tw5.com/tiddlers/readme/ContributingTemplate.tid @@ -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//