Kexi/Getting Started: Difference between revisions

From KDE Community Wiki
No edit summary
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Ways for contribution==
Welcome! This is a ''Getting Started'' page for Kexi on the community.kde.org -- a wiki for developers and by developers. It's like a notepad and a planning board in one. You can create account there even now.
 
Good start is to visit Calligra page [[Calligra/First_Contact|First Contact]]. This page is for entire Calligra Suite, but there are lots of general knowledge useful for Kexi development too.
 
{{Note|If you're still looking for a cool task, just contact us! Many tasks are not documented here and we can adjust to your interests, capabilities and needs!}}
==Ways to contribute==
*Tester
*Tester
*Developer
*Developer
Line 7: Line 12:
See [[../Contact/]].
See [[../Contact/]].


==Common tools==
==Common activity==
*[http://techbase.kde.org/Contribute#Reporting_Bugs Reporting issues, wishes or bugs]
*[[../File_a_bug_or_wish|Reporting issues, wishes or bugs]] (quick link: {{BugReport|Kexi}})
*[[Calligra/Download|Download Calligra]] to run it
*[[Calligra/Download|Download Calligra]] to run it
*What does testing mean?
**Identifying crashes or misbehaviour
**Locating places where Kexi is inefficient (e.g. for large data sets) or hangs
**Checking particular functionality and proposing extensions, e.g. data importing functions
**Comparing the application to the competition and identify the most desired features that Kexi currently lacks
**Testing for usability, e.g. identifying functions that are hard to use or locate
**Testing for accessibility, e.g. identify areas of the application that are not clearly visible on non-default color settings or cannot be used without mouse
**Testing for localisations issues, including support for right-to-left languages, etc. (note: errors in translations to other languages should be reported to a particular [http://i18n.kde.org/teams/ translation team])
**Locating errors in [http://userbase.kde.org/Kexi#Documentation.2C_Tutorials_and_Samples Documentation, Tutorials and Samples], report unclear or incomplete paragraphs, outdated or missing screen shots (the above note about translation teams also apply to translated documentation)


==Specific for Developers==
==Specific for Developers==
*[[Calligra/FAQ#I_am_developer.2C_how_to_contribute_a_patch.3F|Contributing a Patch]] (applies to all Calligra apps)
*[[Calligra/FAQ#I_am_developer.2C_how_to_contribute_a_patch.3F|Contributing a Patch]] (applies to all Calligra apps, '''but note: Kexi uses phabricator.kde.org, not reviewboard''')
*[http://api.kde.org/ Calligra API reference]
*[http://api.kde.org/ Calligra API reference]
*[[Calligra/Building|Building Kexi as part of Calligra]] (other Calligra apps can be built or only Kexi)
*[[Calligra/Building|Building Kexi as part of Calligra]] (other Calligra apps can be built or only Kexi)
Line 22: Line 36:
*After starting Kexi for the first time, a new empty database can be created. [http://docs.kde.org/stable/en/koffice/kexi/index.html Handbook (old)] can be used to get information how to do this.
*After starting Kexi for the first time, a new empty database can be created. [http://docs.kde.org/stable/en/koffice/kexi/index.html Handbook (old)] can be used to get information how to do this.
*To test support for server databases, access to a server is needed. It can be the same computer as the used desktop or laptop machine, but database server software have to be installed on it. Users that lack knowledge on how to do this should ask someone (e.g. a network administrator) to do so.
*To test support for server databases, access to a server is needed. It can be the same computer as the used desktop or laptop machine, but database server software have to be installed on it. Users that lack knowledge on how to do this should ask someone (e.g. a network administrator) to do so.
*Example databases on a database server (MySQL, PostgreSQL) useful to test server connections '''will be provided later''' after contributor provides a server space.
*Beginner users may also want to use [http://kde-files.org/content/show.php/Simple+Database?content=23137 example database] as a reference.
*Beginner users may also want to use [http://kde-files.org/content/show.php/Simple+Database?content=23137 example database] as a reference.


Line 27: Line 42:
*General [[Calligra/FAQ|Calligra FAQ]]
*General [[Calligra/FAQ|Calligra FAQ]]
*[http://techbase.kde.org/Contribute Contribution options described on KDE Techbase]
*[http://techbase.kde.org/Contribute Contribution options described on KDE Techbase]
 
*Kexi 1.x has a wiki at http://kexi-project.org/wiki/wikiview/ - you may be directed there somehow (e.g. via google search or other links) but just note that knowledge published there may a bit outdated be at places. And we're trying to migrate fresh to this wiki.
<ul>
<li> These databases are saved in self-contained files for your convenience:
<ul>
<li> <a href="http://kexi-project.org/download/examples/Simple_Database.kexi">Simple Database.kexi</a> (click+SHIFT on this to download); If you compiled Kexi from
<li> A database with <a href="http://kexi-project.org/download/examples/large_db.kexi.bz2"><img src="images/tgz.png" alt"" border="0">&nbsp;Large data</a> (~600KB, download it and uncompress before use)
 
</ul>
<li> Example databases on a database server (MySQL, PostgreSQL) useful to test server connections. <strong>Will be provided, more information is PLANNED here. Please offere a server space if you can. Please provide test databases if you have such (must be legal).</strong>.
</ul>
</ul>
<a class="totoc" href="[email protected]#__TOC">^ toc</a><a name="What_to_Test_"></a><h2>
What to Test?
</h2>
<p>
You can:
</p>
<ul>
<li> test for crashes or misbehaviour
 
<li> locate places where Kexi is ineffective (e.g. for large data sets) or hangs
<li> test particular functionality and propose entensions, e.g. data importing functions
<li> compare the application to the competition and identify the most expected features that Kexi currently lacks
<li> test for usability
<li> test for accessibility
<li> test for localizations issues, including support for right-to-left languages, etc. (note: errors in translations to other languages should be reported to a particular <a href="http://i18n.kde.org/teams/">translation team<img src="images/external.gif" align="top" alt="" border="0"/></a>)
<li> locate errors in the <a href="[email protected]">Kexi Handbook</a>, report unclear or incomplete paragraphs, outdated or missing screenshots (the above note about translation teams also apply to translated documentation)
 
</ul>
<a class="totoc" href="index.[email protected]#__TOC">^ toc</a><a name="How_to_Report_Bugs"></a><h2>
How to Report Bugs
</h2>
<ul>
<li> Use the wizard at <a href="http://bugs.kde.org/wizard.cgi">bugs.kde.org<img src="images/external.gif" align="top" alt="" border="0"/></a> (KDE Bug Tracking System) to submit a bug report or a wish. First check using <a href="http://bugs.kde.org/buglist.cgi?short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr&long_desc=&product=kexi&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=RESOLVED&bug_status=VERIFIED&bug_status=CLOSED&bugidtype=include&bug_id=&votes=&emailtype1=exact&email1=&emailtype2=substring&email2=&changedin=&chfieldfrom=&chfieldto=Now&chfieldvalue=&order=Reuse+same+sort+as+last+time&cmdtype=doit&newqueryname=&namedcmd=all+kexi+bugs">this query tool<img src="images/external.gif" align="top" alt="" border="0"/></a> if there's already similar bug or wish reported. Carefully read advices on the wizard's pages. Specify your operating system version and Kexi version. Attach an example file (or paste a link to it if the file is large). This helps a lot, and you will get faster and more accurate response.
<li> Related KDE Bug Tracking System's tools:
<ul>
 
<li> <a href="http://bugs.kde.org/component-report.cgi?product=kexi">Report Count by Kexi's Component and Severity<img src="images/external.gif" align="top" alt="" border="0"/></a>
<li> <a href="http://bugs.kde.org/reports.cgi?product=kexi&output=most_doomed&datasets=NEW%3A&datasets=ASSIGNED%3A&datasets=REOPENED%3A&datasets=UNCONFIRMED%3A&links=1&banner=1&quip=0">Kexi chart for bugs ownership<img src="images/external.gif" align="top" alt="" border="0"/></a>
</ul>
<li> <a href="http://kexi-project.org/contact.html">Contact Kexi developers</a> by mail or by visiting #kexi and #koffice IRC channels.
</ul>
 
<br>

Latest revision as of 17:11, 8 November 2016

Welcome! This is a Getting Started page for Kexi on the community.kde.org -- a wiki for developers and by developers. It's like a notepad and a planning board in one. You can create account there even now.

Good start is to visit Calligra page First Contact. This page is for entire Calligra Suite, but there are lots of general knowledge useful for Kexi development too.

Note

If you're still looking for a cool task, just contact us! Many tasks are not documented here and we can adjust to your interests, capabilities and needs!

Ways to contribute

  • Tester
  • Developer
  • Promoter

Communication channels

See Contact.

Common activity

  • Reporting issues, wishes or bugs (quick link: Report bug or wish for Kexi)
  • Download Calligra to run it
  • What does testing mean?
    • Identifying crashes or misbehaviour
    • Locating places where Kexi is inefficient (e.g. for large data sets) or hangs
    • Checking particular functionality and proposing extensions, e.g. data importing functions
    • Comparing the application to the competition and identify the most desired features that Kexi currently lacks
    • Testing for usability, e.g. identifying functions that are hard to use or locate
    • Testing for accessibility, e.g. identify areas of the application that are not clearly visible on non-default color settings or cannot be used without mouse
    • Testing for localisations issues, including support for right-to-left languages, etc. (note: errors in translations to other languages should be reported to a particular translation team)
    • Locating errors in Documentation, Tutorials and Samples, report unclear or incomplete paragraphs, outdated or missing screen shots (the above note about translation teams also apply to translated documentation)

Specific for Developers

Specific for non-Developers

  • Starting: "I am not developer, I cannot or do not like to program. How can I help?"
  • For testing, possibly the newest Kexi version should be used
  • After starting Kexi for the first time, a new empty database can be created. Handbook (old) can be used to get information how to do this.
  • To test support for server databases, access to a server is needed. It can be the same computer as the used desktop or laptop machine, but database server software have to be installed on it. Users that lack knowledge on how to do this should ask someone (e.g. a network administrator) to do so.
  • Example databases on a database server (MySQL, PostgreSQL) useful to test server connections will be provided later after contributor provides a server space.
  • Beginner users may also want to use example database as a reference.

Other information