1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-08-08 06:43:49 +00:00

Docs update

This commit is contained in:
Jermolene 2013-12-18 16:29:45 +00:00
parent 72f07947ea
commit 1144504bb3

View File

@ -1,13 +1,14 @@
created: 201311011114 created: 20131101111400000
modified: 201311301614 modified: 20131218121606089
tags: introduction tags: introduction
title: Contributing title: Contributing
type: text/vnd.tiddlywiki
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. 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 !! Bug Reports
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: For effective debugging, we need as much information as possible. At a minimum, please try to include:
* A descriptive title * A descriptive title
* A summary * A summary
@ -15,6 +16,8 @@ From the perspective of the developers, a bug report that says little more than
* Expected behaviour * Expected behaviour
* Context (OS, browser etc.) * 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: 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://mhay68.tumblr.com/post/1648223018/what-makes-a-good-bug-report
@ -22,7 +25,7 @@ There's a lot of good material on the web about bug reports:
!! Pull Requests !! Pull Requests
Like other OpenSource projects, TiddlyWiki5 needs a signed contributor license agreement 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 UnaMesa Association (the legal entity that owns TiddlyWiki on behalf of the community). Like other OpenSource projects, TiddlyWiki5 needs a signed contributor license agreement from individual contributors. 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 UnaMesa Association (the legal entity that owns TiddlyWiki on behalf of the community).
* For individuals use: [[licenses/CLA-individual|https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-individual.md]] * For individuals use: [[licenses/CLA-individual|https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-individual.md]]
* For entities use: [[licenses/CLA-entity|https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-entity.md]] * For entities use: [[licenses/CLA-entity|https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-entity.md]]