mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-04-10 20:56:39 +00:00
Code Issues Releases Wiki Activity

Docs updates on Reporting Bugs

Browse Source
This commit is contained in:
Jermolene 2014-06-09 14:16:21 +01:00
parent fc6d96672d
commit b446ef5d4e
2 changed files with 46 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
editions/tw5.com-server/tiddlers/ReportingBugs.tid Normal file
View File

@ -0,0 +1,43 @@
created: 20140604204709181
modified: 20140604205253392
tags: resources tips
title: ReportingBugs
type: text/vnd.tiddlywiki
There are two ways to report bugs in TiddlyWiki:
* via the TiddlyWiki discussion group (requires a Google account)
** http://groups.google.com/group/TiddlyWiki
* via the TiddlyWiki GitHub repository (requires a GitHub account)
** https://github.com/Jermolene/TiddlyWiki5/issues/new
Unless you are already familiar with GitHub, it's usually easiest to report problems through the discussion groups.
! TiddlyWiki on GitHub
We use GitHub Issues to manage bug reports and feature requests for TiddlyWiki. To maintain their effectiveness we endeavour to have as few open issues as possible.
!!! Policies for Managing Issues
Open issues should be actionable: generally either a reproducible bug report, or a specific feature request. From the perspective of the core developers, the issues list behaves like a shared todo list. Every item on the list requires a little bit of attention each time we check the list.
GitHub Issues are not very good for managing ideas that are not immediately actionable. Better to use the [[TiddlyWiki discussion groups|Community]] for open ended questions, or speculative discussions of new features.
!!! Creating Issues
Before creating a GitHub issue it is good etiquette to search through the existing issues to see whether the problem has already been reported. If a search isn't practical, don't worry too much; GitHub makes it easy to merge existing issues.
When you do create an issue, remember that for effective debugging, we need as much information as possible. At a minimum, please try to include:
* A descriptive title
* A summary
* Steps to reproduce
* Expected behaviour
* Context (OS, browser etc.)
Consider also adding screenshots if it makes things clearer.
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

29
editions/tw5.com/tiddlers/Contributing.tid
View File

@ -1,5 +1,5 @@
created: 20131101111400000
modified: 20140112164329806
modified: 20140607164329806
tags: introduction
title: Contributing
type: text/vnd.tiddlywiki
@ -12,30 +12,7 @@ Code contributions should follow the [[TiddlyWiki Coding Style Guidelines]].
!! GitHub Issues
We use GitHub Issues to manage bug reports, feature requests for TiddlyWiki. To maintain their effectiveness we endeavour to have as few open issues as possible.
!!! Policies for Managing Issues
Open issues must be actionable: generally either a reproducible bug report, or a specific feature request. From the perspective of the core developers, the issues list behaves like a shared todo list. Every item on the list requires a little bit of attention each time we check the list.
GitHub Issues are not very good for managing ideas that are not immediately actionable. Better to use the [[TiddlyWiki discussion groups|Community]] for open ended questions, or speculative discussions of new features.
!!! Creating Issues
When you do create an issue, remember that for effective debugging, we need as much information as possible. At a minimum, please try to include:
* A descriptive title
* A summary
* Steps to reproduce
* Expected behaviour
* Context (OS, browser etc.)
Consider also adding screenshots if it makes things clearer.
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
See ReportingBugs for information about how TiddlyWiki handles bug reports.
!! Contributor License Agreement
@ -56,4 +33,4 @@ eg: `Jeremy Ruston, @Jermolene, 2011/11/22`
!!!! Attribution
The CLA documents used for this project where created using [[Harmony Project Templates|http://www.harmonyagreements.org]]. "~HA-CLA-I-LIST Version 1.0" for "CLA-individual" and "~HA-CLA-E-LIST Version 1.0" for "CLA-entity"
The CLA documents used for this project were created using [[Harmony Project Templates|http://www.harmonyagreements.org]]. "~HA-CLA-I-LIST Version 1.0" for "CLA-individual" and "~HA-CLA-E-LIST Version 1.0" for "CLA-entity"