Entwicklerrichtlinien/Styleguide: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
(Anfang) |
(Qualitätssicherung) |
||
Zeile 6: | Zeile 6: | ||
Alles was programmiert wird, soll sich an diese Richtlinien halten. Einige Dinge wie die Paketerstellung & -verwaltung, sowie die Konfiguration des Installers müssen sich auch an die "Debian Policy" halten. | Alles was programmiert wird, soll sich an diese Richtlinien halten. Einige Dinge wie die Paketerstellung & -verwaltung, sowie die Konfiguration des Installers müssen sich auch an die "Debian Policy" halten. | ||
== Styleguide == | |||
Für das einheitliche Aussehen aller delixs-Werkzeuge, folgend "Admin-Interface" genannt, wird ein Styleguide erstellt. | |||
== Qualitätssicherung == | |||
Wenn sie ihr Script bzw. ihre Lösung dem delixs-Projekt zur Verfügung stellen wollen, dann muss es wegen der langfristigen Sicherung des Supports bestimmten Ansprüchen genügen. Diese Qualitätsansprüche werden im Folgenden angegeben: | |||
* Passworte, Hostnamen, IP-Adressen oder kurz: '''sämtliche variablen Daten''' sind nie im Script direkt anzugeben, sondern sollten immer aus der jeweiligen Datei (Beispiel: "ldap.secret") eingelesen werden. | |||
* da jede Schule eine andere Suchbasis (hier LDAP-Base genannt) hat, sollte das Script diese aus der /etc/ldap.conf auslesen. Das kann so geschehen: | |||
# wir holen uns die Such-Basis ($ldap_base) aus der ldap.conf | |||
open DATEI, '<', '/etc/ldap.conf' | |||
or die "konnte ldap.conf nicht oeffnen, $!\n"; | |||
while (my $zeile = <DATEI>) { | |||
if ($zeile =~ m/^\s*base\s+(\w.*\w)\s*$/) { | |||
$ldap_base = $1; | |||
last; | |||
} | |||
} | |||
close DATEI; | |||
---- | ---- | ||
<div align="right">[[Delixs:Entwickler|zurück]] | [[Hauptseite]]</div> | <div align="right">[[Delixs:Entwickler|zurück]] | [[Hauptseite]]</div> |
Version vom 25. April 2008, 15:17 Uhr
Diese Seite sollte nochmals überarbeitet werden. Eine Begründung befindet sich in der Regel unter Diskussion (oben). |
Leben mit Debian: Die Entwickler Richtlinien
Alles was programmiert wird, soll sich an diese Richtlinien halten. Einige Dinge wie die Paketerstellung & -verwaltung, sowie die Konfiguration des Installers müssen sich auch an die "Debian Policy" halten.
Styleguide
Für das einheitliche Aussehen aller delixs-Werkzeuge, folgend "Admin-Interface" genannt, wird ein Styleguide erstellt.
Qualitätssicherung
Wenn sie ihr Script bzw. ihre Lösung dem delixs-Projekt zur Verfügung stellen wollen, dann muss es wegen der langfristigen Sicherung des Supports bestimmten Ansprüchen genügen. Diese Qualitätsansprüche werden im Folgenden angegeben:
- Passworte, Hostnamen, IP-Adressen oder kurz: sämtliche variablen Daten sind nie im Script direkt anzugeben, sondern sollten immer aus der jeweiligen Datei (Beispiel: "ldap.secret") eingelesen werden.
- da jede Schule eine andere Suchbasis (hier LDAP-Base genannt) hat, sollte das Script diese aus der /etc/ldap.conf auslesen. Das kann so geschehen:
# wir holen uns die Such-Basis ($ldap_base) aus der ldap.conf open DATEI, '<', '/etc/ldap.conf' or die "konnte ldap.conf nicht oeffnen, $!\n"; while (my $zeile = <DATEI>) { if ($zeile =~ m/^\s*base\s+(\w.*\w)\s*$/) { $ldap_base = $1; last; } } close DATEI;