mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-09 19:39:57 +00:00
Code Issues Releases Wiki Activity
5e743262d4
TiddlyWiki5/contributing.md
Jeremy Ruston 3ecd3c8e71 Revise contributors documentation
2013-09-27 16:15:55 +01:00

4.4 KiB
Raw Blame History

Contributing to TiddlyWiki5

TiddlyWiki5 welcomes contributions to its code and documentation via GitHub. 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:

Pull Requests

Like other OpenSource projects, TiddlyWiki5 needs a signed ContributorLicenseAgreement 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).

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. "HA-CLA-I-LIST Version 1.0" for "CLA-individual" and "HA-CLA-E-LIST Version 1.0" for "CLA-entity"

This file was automatically generated by TiddlyWiki5