Difference between revisions of "An exercise for new contributors"

From GCompris
Jump to: navigation, search
m (Exercise)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
== Exercise ==
 
== Exercise ==
  
In order to help you practice in the GCompris framework, I propose you to make this little exercise.
+
In order to help you practice in the GCompris framework, we propose you to make this little exercise.
  
 
'''Mandatory:''' GCompris development is done on a '''GNU/Linux''' distribution of your choice.
 
'''Mandatory:''' GCompris development is done on a '''GNU/Linux''' distribution of your choice.
  
 
* Install GNU/Linux on your computer if you don't already have it.
 
* Install GNU/Linux on your computer if you don't already have it.
* Download and Install the latest stable version of [https://www.qt.io/download-open-source/#section-2 QtCreator] (version 5.5.0 recommended)  
+
* Download and Install the latest stable version of [https://www.qt.io/download-open-source/#section-2 Qt] (version 5.9.3 recommended, 5.6 is the minimal one)
 
* Install [https://cmake.org/download/ CMake] (version 3.5.1 recommended)
 
* Install [https://cmake.org/download/ CMake] (version 3.5.1 recommended)
 
* Get the GCompris code from the Kde Git version control system (or see below the GitHub option).
 
* Get the GCompris code from the Kde Git version control system (or see below the GitHub option).
Line 30: Line 30:
 
* Use git add and git commit to commit your changes locally.
 
* Use git add and git commit to commit your changes locally.
 
** git add 'my new activity'
 
** git add 'my new activity'
** git commit -a
+
** git commit -m "commitMessage"
  
 
=== Publish your patch on GitHub ===
 
=== Publish your patch on GitHub ===
  
 
* Create an account on [https://github.com github]
 
* Create an account on [https://github.com github]
* Fork [git@github.com:gcompris/GCompris-qt.git GCompris]
+
* Fork [https://github.com/gcompris/GCompris-qt GCompris]
 
** Look at these [http://help.github.com/fork-a-repo/ instructions]
 
** Look at these [http://help.github.com/fork-a-repo/ instructions]
 
* Code your activity
 
* Code your activity
Line 41: Line 41:
 
* Push it
 
* Push it
 
** git push
 
** git push
* On github send a pull request
+
* Send a pull request on github or create a task in the "Need review" section at https://phabricator.kde.org/project/view/142/ with the description and link to your diff at https://phabricator.kde.org/differential/diff/create/
  
 +
You can visit [http://gcompris.net/wiki/Qt_Quick_development_process Qt Quick development process] for more details.
  
 
[[Category:English]]
 
[[Category:English]]

Latest revision as of 17:46, 21 December 2017

Exercise

In order to help you practice in the GCompris framework, we propose you to make this little exercise.

Mandatory: GCompris development is done on a GNU/Linux distribution of your choice.

  • Install GNU/Linux on your computer if you don't already have it.
  • Download and Install the latest stable version of Qt (version 5.9.3 recommended, 5.6 is the minimal one)
  • Install CMake (version 3.5.1 recommended)
  • Get the GCompris code from the Kde Git version control system (or see below the GitHub option).
  • Configure you Git username and email
    • git config --global user.email "your_email@example.com"
    • git config --global user.name "FirstName LastName"
  • Create a branch for your development
    • git checkout -b exercise
  • Start QtCreator and open the project file CMakeLists.txt at the root of the source code
  • Compile and run it.
  • Create a new activity using the supplied createit.sh script. For example, use your nick name as the activity name.
    • cd src/activities
    • ./createit.sh 'my_new_activity'
  • Update the copyrights of the different files with your name and email.
  • Compile GCompris again in Qt Creator, check you new activity is present
  • Modify the activity to display an image, a rectangle and a text.
  • (Warning, if you add resources in you activity's resource directory you must run cmake again).
  • Add an event to a graphical object so that clicking on it does something visual.
  • Use git add and git commit to commit your changes locally.
    • git add 'my new activity'
    • git commit -m "commitMessage"

Publish your patch on GitHub

You can visit Qt Quick development process for more details.