Wie Werde Ich ein BlueSpice Hacker: Unterschied zwischen den Versionen

[unfreigegebene Version][unfreigegebene Version]
 

Dieser Artikel soll Entwicklern helfen, die notwendigen Fähigkeiten zu erwerben, um zur BlueSpice-Entwicklung beitragen zu können.

Warum solltest Du mitmachen?
Wenn Du Dich aktiv im Projekt beteiligst, hast Du die Chance dieses mitzugestalten. Ganz nach dem Motto "Veränderungen entstehen vor allem durch "Machen"", kannst Du Dich also einbringen. Großer Dank ist Dir sowieso sicher, aber selbstverständlich wird auch Dein Name in Bezug auf Deine jeweilige Mitarbeit öffentlich genannt. Ganz abgesehen davon, dass Du nicht nur uns, sondern den vielen Nutzern da draußen hilfst, die Dir ein Stilles oder Lautes Danke zukommen lassen.

Mitmachen[Bearbeiten | Quelltext bearbeiten]

Wie in allen Projekten gibt es die unterschiedlichsten Arten, wie Du Dich beteiligen kannst. Hier einige Beispiele wie Du Teil des BlueSpice-Projektes werden kannst.

Verbesserung der Code Qualität[Bearbeiten | Quelltext bearbeiten]

  • Docblöcke: Schreibe mit uns Dokumentationsblöcke im Quellcode. Du hilfst damit den Code zu vervollständigen und Unstimmigkeiten aufzudecken. Mehr zu den MediaWiki DocBlocks bei wikimedia.
  • Coding conventions: Hilf mit die Coding Conventions durchzusetzen. Wir nutzen dazu die Coding Conventions von MediaWiki.
  • Sicherheit: Sicherheit wird bei uns groß geschrieben. Wenn Du möchtest kannst Du helfen, diese weiter zu verbessern. Dazu solltest Du dich an die Empfehlungen für die Sicherheit für Entwickler halten.

Bugfixes[Bearbeiten | Quelltext bearbeiten]

Du kannst Ausschau halten nach kleineren und größeren Bugs. Wenn Dir nicht nur ein Bug auffällt, sondern Du auch gleich die Lösung programmiert hat - umso besser!
Hier eine Hilfestellung zum Debugging in MediaWiki

Code Review[Bearbeiten | Quelltext bearbeiten]

Hilf uns Entwicklungen zu bewerten. Dazu musst Du Dich in gerrit auskennen. Mehr dazu findest Du unter dem Punkt "Entwicklungsumgebung aufsetzen" und "Änderungen einchecken".

Kleine Ergänzungen[Bearbeiten | Quelltext bearbeiten]

Viele der existierenden Extensions bieten sich an, um weiterentwickelt zu werden und erweiterte Funktionalitäten anzubieten. Ganz konkret haben wir dafür im Kopf:
Dashboard Widgets, Statistiken, Sidebar Widgets, etc.

Eigene Erweiterungen[Bearbeiten | Quelltext bearbeiten]

Du kannst natürlich auch eigene Erweiterungen für BlueSpice schreiben. Bitte halte dazu den MediaWiki Workflow ein. Auf den MediaWiki Seiten findest Du ausführliche Hinweise wie Du eine eigene MediaWiki Extension entwickelst und was Du dazu beachten solltest. Diese Hinweise gelten auch für BlueSpice. Bitte lege für eigene Erweiterungen in gerrit ein eigenes Verzeichnis an, das wie folgt benannt ist:

mediawiki/skins/BlueSpiceDeine Erweiterung

Übersetzungen[Bearbeiten | Quelltext bearbeiten]

Übersetzungen werden natürlich jederzeit gebraucht. Bitte wende Dich dazu an die Community von translatewiki.net. Einen Überblick findest Du auf unserer dortigen Projektseite.

Und so läuft das Ganze ab[Bearbeiten | Quelltext bearbeiten]

Änderungen einchecken[Bearbeiten | Quelltext bearbeiten]

Du hast zwei Möglichkeiten Deine Patches einzubringen.

1. E-Mail an Hallo Welt!

Sende eine E-Mail mit Deinem Patch (git format-patch) an support@hallowelt.biz. Wir checken dann die Änderung für Dich im Git-System ein, wo es den üblichen Prozess durchläuft.

2. Aktiv Mitmachen über das Git

Wir folgen hier genau dem Prozedere, das auch für die Beteiligung an der MediaWiki-Entwicklung vorgesehen ist:

  • Entwickler-Account bei MediaWiki holen
  • Git-review installieren
  • Code von BlueSpice auschecken
  • Änderungen vornehmen und einchecken
  • Änderungen werden in Gerrit gegengeprüft
  • Sobald alles passt, werden die Änderungen übernommen

Auf MediaWiki.org findet sich dazu auch eine kurze und eine ausführliche Anleitung.

Der Code von BlueSpice befindet sich in den folgenden Repositories:

mediawiki/extensions/BlueSpiceFoundation.git
mediawiki/extensions/BlueSpiceExtensions.git
mediawiki/skins/BlueSpiceSkin.git

und kann so ausgecheckt werden:

git clone ssh://@gerrit.wikimedia.org:29418/mediawiki/extensions/BlueSpiceFoundation.git 

In den Repositories von BlueSpice ist es notwendig, das "+2" oder "Merge"-Recht zu haben, bevor man den Code selbst in das Produkt einpflegen kann. Um dieses zu bekommen, wendet euch an glaser@hallowelt.biz.

Wenn ihr eine eigene BlueSpice-Erweiterung schreiben wollt, lasst euch hier ein eigenes Repository geben. Am besten folgt ihr der Namenskonvention

mediawiki/extensions/BlueSpiceMeinWidget.git

Entwicklungsumgebung aufsetzen[Bearbeiten | Quelltext bearbeiten]

Eine ausführliche beschreibung haben wir auf eine eigene Seite Installationsanleitung gepackt.

See also[Bearbeiten | Quelltext bearbeiten]

<bookshelf src="Book:Nutzerhandbuch" />
            Dieser Artikel soll Entwicklern helfen, die notwendigen Fähigkeiten zu erwerben, um zur BlueSpice-Entwicklung beitragen zu können. 
        

        '''Warum solltest Du mitmachen?'''<br />
        
        Wenn Du Dich aktiv im Projekt beteiligst, hast Du die Chance dieses mitzugestalten. Ganz nach dem Motto "Veränderungen entstehen vor allem durch "Machen"", kannst Du Dich also einbringen. Großer Dank ist Dir sowieso sicher, aber selbstverständlich wird auch Dein Name in Bezug auf Deine jeweilige Mitarbeit öffentlich genannt. Ganz abgesehen davon, dass Du nicht nur uns, sondern den vielen Nutzern da draußen hilfst, die Dir ein Stilles oder Lautes Danke zukommen lassen.
        

        ==Mitmachen==
        
        Wie in allen Projekten gibt es die unterschiedlichsten Arten, wie Du Dich beteiligen kannst. Hier einige Beispiele wie Du Teil des BlueSpice-Projektes werden kannst.
        

        ===Verbesserung der Code Qualität===
        
        * Docblöcke: Schreibe mit uns Dokumentationsblöcke im Quellcode. Du hilfst damit den Code zu vervollständigen und Unstimmigkeiten aufzudecken. Mehr zu den [http://meta.wikimedia.org/wiki/PhpDoc MediaWiki DocBlocks] bei wikimedia.
        
        * Coding conventions: Hilf mit die Coding Conventions durchzusetzen. Wir nutzen dazu die [http://www.mediawiki.org/wiki/Manual:Coding_conventions Coding Conventions von MediaWiki].
        
        * Sicherheit: Sicherheit wird bei uns groß geschrieben. Wenn Du möchtest kannst Du helfen, diese weiter zu verbessern. Dazu solltest Du dich an die Empfehlungen für die [http://www.mediawiki.org/wiki/Security_for_developers Sicherheit für Entwickler] halten.
        

        ===Bugfixes===
        
        Du kannst Ausschau halten nach kleineren und größeren Bugs. Wenn Dir nicht nur ein Bug auffällt, sondern Du auch gleich die Lösung programmiert hat - umso besser!<br />
        
        Hier eine Hilfestellung zum [http://www.mediawiki.org/wiki/Manual:How_to_debug/de Debugging in MediaWiki]
        

        ===Code Review===
        
        Hilf uns Entwicklungen zu bewerten. Dazu musst Du Dich in gerrit auskennen. Mehr dazu findest Du unter dem Punkt "Entwicklungsumgebung aufsetzen" und "Änderungen einchecken".
        

        * [http://gerrit.wikimedia.org/r/#/q/status:open+project:mediawiki/extensions/BlueSpiceExtensions,n,z BlueSpice Extensions]
        
        * [http://gerrit.wikimedia.org/r/#/q/status:open+project:mediawiki/extensions/BlueSpiceFoundation,n,z BlueSpice Foundation]
        
        * [http://gerrit.wikimedia.org/r/#/q/status:open+project:mediawiki/skins/BlueSpiceSkins,n,z BlueSpice Skin]
        

        ===Kleine Ergänzungen===
        
        Viele der existierenden Extensions bieten sich an, um weiterentwickelt zu werden und erweiterte Funktionalitäten anzubieten. Ganz konkret haben wir dafür im Kopf:<br />
        
        Dashboard Widgets, Statistiken, Sidebar Widgets, etc.
        

        ===Eigene Erweiterungen===
        
        Du kannst natürlich auch eigene Erweiterungen für BlueSpice schreiben. Bitte halte dazu den MediaWiki Workflow ein. Auf den MediaWiki Seiten findest Du ausführliche Hinweise wie Du eine eigene [http://www.mediawiki.org/wiki/Manual:Developing_extensions MediaWiki Extension entwickelst] und was Du dazu beachten solltest. Diese Hinweise gelten auch für BlueSpice.
        
        Bitte lege für eigene Erweiterungen in gerrit ein eigenes Verzeichnis an, das wie folgt benannt ist:
        
<pre>mediawiki/skins/BlueSpiceDeine Erweiterung</pre>
        
        ===Übersetzungen===
        
        Übersetzungen werden natürlich jederzeit gebraucht. Bitte wende Dich dazu an die Community von [https://translatewiki.net translatewiki.net].
        
        Einen Überblick findest Du auf unserer dortigen Projektseite.
        

        ==Und so läuft das Ganze ab==
        
        ===Änderungen einchecken===
        
        Du hast zwei Möglichkeiten Deine Patches einzubringen.
        

        '''1. E-Mail an Hallo Welt'''!
        

        Sende eine E-Mail mit Deinem Patch ([https://www.kernel.org/pub/software/scm/git/docs/git-format-patch.html git format-patch]) an support@hallowelt.biz. Wir checken dann die Änderung für Dich im Git-System ein, wo es den üblichen Prozess durchläuft.
        

        '''2. Aktiv Mitmachen über das Git'''
        

        Wir folgen hier genau dem Prozedere, das auch für die Beteiligung an der MediaWiki-Entwicklung vorgesehen ist:
        

        * Entwickler-Account bei MediaWiki holen
        
        * Git-review installieren
        
        * Code von BlueSpice auschecken
        
        * Änderungen vornehmen und einchecken
        
        * Änderungen werden in Gerrit gegengeprüft
        
        * Sobald alles passt, werden die Änderungen übernommen
        

        Auf MediaWiki.org findet sich dazu auch eine [https://www.mediawiki.org/wiki/Gerrit/Getting_started kurze] und eine [https://www.mediawiki.org/wiki/Gerrit/Tutorial ausführliche] Anleitung.
        

        Der Code von BlueSpice befindet sich in den folgenden Repositories:
        

         mediawiki/extensions/BlueSpiceFoundation.git
        
         mediawiki/extensions/BlueSpiceExtensions.git
        
         mediawiki/skins/BlueSpiceSkin.git
        

        und kann so ausgecheckt werden:
        

         git clone <nowiki>ssh://@gerrit.wikimedia.org:29418/mediawiki/extensions/BlueSpiceFoundation.git</nowiki> 
        

        In den Repositories von BlueSpice ist es notwendig, das "+2" oder "Merge"-Recht zu haben, bevor man den Code selbst in das Produkt einpflegen kann. Um dieses zu bekommen, wendet euch an glaser@hallowelt.biz.
        

        Wenn ihr eine eigene BlueSpice-Erweiterung schreiben wollt, lasst euch [https://www.mediawiki.org/wiki/Gerrit/New_repositories#Step_3:_Request_space_for_your_extension hier] ein eigenes Repository geben. Am besten folgt ihr der Namenskonvention
        

         mediawiki/extensions/BlueSpiceMeinWidget.git
        

        ===Entwicklungsumgebung aufsetzen===
        
        Eine ausführliche beschreibung haben wir auf eine eigene Seite [[Wie_Werde_Ich_ein_BlueSpice_Hacker/Installation|Installationsanleitung]] gepackt.
        

        ==See also==
        
        * https://www.mediawiki.org/wiki/How_to_become_a_MediaWiki_hacker
        

        [[de:{{FULLPAGENAME}}]][[en:How to become a BlueSpice hacker]]
Zeile 1: Zeile 1:
 +
<bookshelf src="Book:Nutzerhandbuch" />
 
Dieser Artikel soll Entwicklern helfen, die notwendigen Fähigkeiten zu erwerben, um zur BlueSpice-Entwicklung beitragen zu können.  
 
Dieser Artikel soll Entwicklern helfen, die notwendigen Fähigkeiten zu erwerben, um zur BlueSpice-Entwicklung beitragen zu können.  
  

Anhänge

Diskussionen