1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-18 15:54:50 +00:00
TiddlyWiki5/editions/tw5.com/tiddlers/Contributing.tid

27 lines
1.1 KiB
Plaintext
Raw Normal View History

2013-07-02 07:38:00 +00:00
modified: 201307020736
title: Contributing
2013-08-08 16:38:16 +00:00
tags: introduction
2013-07-02 07:38:00 +00:00
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.
2013-07-02 07:48:01 +00:00
! Bug Reports
2013-07-02 07:38:00 +00:00
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.//