mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-27 12:07:19 +00:00
Code Issues Releases Wiki Activity

reversed contributing.md, since it will be created automatically. Use the Contributing.tid instead. Minor tweaks to CLA's

Browse Source
This commit is contained in:
Mario Pietsch 2013-09-19 16:49:00 +02:00
parent 1ab1043461
commit f2e9eafdba
4 changed files with 68 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
contributing.md
View File

@ -1,52 +1,34 @@
Contributing <h1 class=''>
============ Contributing to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
TiddlyWiki5</a></h1><div class='tw-tiddler'>
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. <div class='tw-transclude'>
<p>
Bug Reports <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
----------- TiddlyWiki5</a> welcomes contributions to its code and documentation <a class='tw-tiddlylink tw-tiddlylink-external' href='https://github.com/Jermolene/TiddlyWiki5'>
via GitHub</a>. Please take a moment to read these notes to help make the process as smooth as possible.</p><h1 class=''>
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: Bug Reports</h1><p>
From a programmers perspective, a bug report that just says &quot;it doesn't work&quot; is highly frustrating. For effective debugging, we need as much information as possible. At a minimum, please ensure that you include:</p><ul>
* A descriptive title <li>
* A summary A descriptive title</li><li>
* Steps to reproduce A summary</li><li>
* Expected behaviour Steps to reproduce</li><li>
* Context (OS, browser etc.) Expected behaviour</li><li>
Context (OS, browser etc.)</li></ul><p>
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:</p><p>
<a class='tw-tiddlylink tw-tiddlylink-external' href='http://mhay68.tumblr.com/post/1648223018/what-makes-a-good-bug-report'>
http://mhay68.tumblr.com/post/1648223018/what-makes-a-good-bug-report http://www.chiark.greenend.org.uk/~sgtatham/bugs.html http://mhay68.tumblr.com/post/1648223018/what-makes-a-good-bug-report</a>
<a class='tw-tiddlylink tw-tiddlylink-external' href='http://www.chiark.greenend.org.uk/~sgtatham/bugs.html'>
Pull Requests http://www.chiark.greenend.org.uk/~sgtatham/bugs.html</a></p><h1 class=''>
-------------- Pull Requests</h1><p>
Like other <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/OpenSource.html'>
Like other OpenSource projects, TiddlyWiki5 needs a signed ContributorLicenseAgreement from individual contributors before contributions of code can be accepted. OpenSource</a> projects, <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
TiddlyWiki5</a> needs a signed <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='http://five.tiddlywiki.com/static/ContributorLicenseAgreement.html'>
* For individuals use: [CLA-individual](https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-individual.md) ContributorLicenseAgreement</a> from individual contributors before contributions of code can be accepted.</p><p>
* For entities use: [CLA-individual](https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-entity.md) <em>
As of July 2013, <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
### How it works TiddlyWiki5</a> does not yet have the necessary infrastructure to permit CLAs to be signed and retained.</em>
</p></div></div><p>
``` <em>
git clone https://github.com/Jermolene/TiddlyWiki5.git TiddlyWiki5 This file was automatically generated by <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
cd TiddlyWiki5 TiddlyWiki5</a></em>
git checkout -b sign-cla </p>
```
**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.**
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"

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

@ -1,10 +1,10 @@
modified: 201307020736 modified: 201309191633
title: Contributing title: Contributing
tags: introduction 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. 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 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: 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:
@ -16,11 +16,36 @@ From a programmers perspective, a bug report that just says "it doesn't work" is
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 http://www.chiark.greenend.org.uk/~sgtatham/bugs.html
http://www.chiark.greenend.org.uk/~sgtatham/bugs.html
! Pull Requests !! Pull Requests
Like other OpenSource projects, TiddlyWiki5 needs a signed ContributorLicenseAgreement from individual contributors before contributions of code can be accepted. 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.// * 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.''
''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"

2
licenses/cla-entity.md
View File

@ -64,7 +64,7 @@ Any rights not expressly assigned or licensed under this section are expressly r
### 2.7 3rd Party Libraries and Plugins ### 2.7 3rd Party Libraries and Plugins
We may use 3rd party libraries to create TiddlyWiki5 plugins. These libraries may have there own licenses. 3rd party software and licenses are not subject in this CLA, while TiddlyWiki5 plugins, that use these libraries are. 3rd party libraries may be included everywhere, especially in the following directories and there subdirectories: `plugins/` and `editions/`. We may use 3rd party libraries to create TiddlyWiki5 plugins. These libraries may have their own licenses. 3rd party software and licenses are not subject in this CLA, while TiddlyWiki5 plugins that use these libraries are. 3rd party libraries may be included everywhere, especially in the following directories and their subdirectories: `plugins/` and `editions/`.
3. Agreement 3. Agreement

2
licenses/cla-individual.md
View File

@ -59,7 +59,7 @@ Any rights not expressly licensed under this section are expressly reserved by Y
### 2.7 3rd Party Libraries and Plugins ### 2.7 3rd Party Libraries and Plugins
We may use 3rd party libraries to create TiddlyWiki5 plugins. These libraries may have there own licenses. 3rd party software and licenses are not subject in this CLA, while TiddlyWiki5 plugins, that use these libraries are. 3rd party libraries may be included everywhere, especially in the following directories and there subdirectories: `plugins/` and `editions/`. We may use 3rd party libraries to create TiddlyWiki5 plugins. These libraries may have their own licenses. 3rd party software and licenses are not subject in this CLA, while TiddlyWiki5 plugins that use these libraries are. 3rd party libraries may be included everywhere, especially in the following directories and their subdirectories: `plugins/` and `editions/`.
3. Agreement 3. Agreement
------------ ------------