TiddlyWiki5/editions/tw5.com/tiddlers/Contributing.tid

modified: 201309191633
title: Contributing
tags: introduction

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

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.

* For individuals use: [[CLA-individual|https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-individual.md]]
* For entities use: [[CLA-entity|https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-entity.md]]

!!! How to sign the CLA

```
git clone https://github.com/Jermolene/TiddlyWiki5.git TiddlyWiki5
cd TiddlyWiki5
git checkout -b sign-cla
```

''Add your name and the date to cla-individual.md or cla-entity.md''. Date format (YYYY/MM/DD)
eg: `Jermy Ruston - 2011/11/22`

```
git add .
git commit -m "sign contributor license agreement"
git push origin sign-cla
```

''Go to your github repo and create a pull request.''

!!!! Remark for Alpha and Beta Sontributors

This is the first CLA, TiddlyWiki uses. So if we did miss something important, please let us know. If we make essential changes to the CLA, all contributors will need to sign it again. So we should get it right as soon as possible.

''Thank you!''

!!!! 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"
reversed contributing.md, since it will be created automatically. Use the Contributing.tid instead. Minor tweaks to CLA's 2013-09-19 14:49:00 +00:00			`modified: 201309191633`
Add contributing guidelines 2013-07-02 07:38:00 +00:00			`title: Contributing`
Tag corrections 2013-08-08 16:38:16 +00:00			`tags: introduction`
Add contributing guidelines 2013-07-02 07:38:00 +00:00
reversed contributing.md, since it will be created automatically. Use the Contributing.tid instead. Minor tweaks to CLA's 2013-09-19 14:49: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.`
Add contributing guidelines 2013-07-02 07:38:00 +00:00
reversed contributing.md, since it will be created automatically. Use the Contributing.tid instead. Minor tweaks to CLA's 2013-09-19 14:49:00 +00:00			`!! Bug Reports`
Add contributing guidelines 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:`

reversed contributing.md, since it will be created automatically. Use the Contributing.tid instead. Minor tweaks to CLA's 2013-09-19 14:49:00 +00:00			`http://mhay68.tumblr.com/post/1648223018/what-makes-a-good-bug-report http://www.chiark.greenend.org.uk/~sgtatham/bugs.html`
Add contributing guidelines 2013-07-02 07:38:00 +00:00
reversed contributing.md, since it will be created automatically. Use the Contributing.tid instead. Minor tweaks to CLA's 2013-09-19 14:49:00 +00:00			`!! Pull Requests`
Add contributing guidelines 2013-07-02 07:38:00 +00:00
			`Like other OpenSource projects, TiddlyWiki5 needs a signed ContributorLicenseAgreement from individual contributors before contributions of code can be accepted.`

reversed contributing.md, since it will be created automatically. Use the Contributing.tid instead. Minor tweaks to CLA's 2013-09-19 14:49:00 +00:00			`* For individuals use: [[CLA-individual\|https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-individual.md]]`
			`* For entities use: [[CLA-entity\|https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-entity.md]]`

			`!!! How to sign the CLA`

			```
			`git clone https://github.com/Jermolene/TiddlyWiki5.git TiddlyWiki5`
			`cd TiddlyWiki5`
			`git checkout -b sign-cla`
			```

			`''Add your name and the date to cla-individual.md or cla-entity.md''. Date format (YYYY/MM/DD)`
			eg: `Jermy Ruston - 2011/11/22`

			```
			`git add .`
			`git commit -m "sign contributor license agreement"`
			`git push origin sign-cla`
			```

			`''Go to your github repo and create a pull request.''`

added Unamesa Association as (We or Us). Got OK from Jermolene to use CC-BY for media content. 2013-09-21 14:42:31 +00:00			`!!!! Remark for Alpha and Beta Sontributors`

			`This is the first CLA, TiddlyWiki uses. So if we did miss something important, please let us know. If we make essential changes to the CLA, all contributors will need to sign it again. So we should get it right as soon as possible.`

reversed contributing.md, since it will be created automatically. Use the Contributing.tid instead. Minor tweaks to CLA's 2013-09-19 14:49:00 +00:00			`''Thank you!''`

			`!!!! 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"`