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

created: 201311011114
creator: JeremyRuston
modified: 201311011114
modifier: JeremyRuston
tags: introduction
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

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:

* 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 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).

* 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]]

//This is a first pass at a CLA for TiddlyWiki. Please let us know if we missed something important. If we do have to make essential changes to the CLA, there is a possibility that all contributors will need to sign it again//

!!! 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: `Jeremy Ruston, @Jermolene, 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.''

''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"
Docs updates 2013-11-01 11:18:37 +00:00			`created: 201311011114`
			`creator: JeremyRuston`
			`modified: 201311011114`
			`modifier: JeremyRuston`
Tag corrections 2013-08-08 16:38:16 +00:00			`tags: introduction`
Docs updates 2013-11-01 11:18:37 +00:00			`title: Contributing`
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
Revise contributors documentation 2013-09-27 15:15:55 +00:00			`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:`
Add contributing guidelines 2013-07-02 07:38:00 +00:00
			`* 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:`

Put links in a list for readability 2013-09-22 08:54:52 +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
Docs updates 2013-11-01 11:18:37 +00:00			`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).`
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			`* 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]]`

Minor rewording of contributing tiddler 2013-09-21 17:04:22 +00:00			`//This is a first pass at a CLA for TiddlyWiki. Please let us know if we missed something important. If we do have to make essential changes to the CLA, there is a possibility that all contributors will need to sign it again//`

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			`!!! 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)`
Minor rewording of contributing tiddler 2013-09-21 17:04:22 +00:00			eg: `Jeremy Ruston, @Jermolene, 2011/11/22`
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
			```
			`git add .`
			`git commit -m "sign contributor license agreement"`
			`git push origin sign-cla`
			```

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

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