3. Bewährte Projekt- und Archiv- Namensvergabe Praktiken

In dem Ausmass indem die Last auf gewartete Archivseiten wie Metalab, der PSA und CPAN Seite sich exponentiell vergrössert, wird die Möglichkeit Dateinamen von Neuhinzufügungen teilweise oder gänzlich durch Programme einzulesen immer beliebter; im Gegensatz dazu steht die Verarbeitung durch Menschen.

Darum ist es umso wichtiger für Projekt- und Archiv-Dateinamen, dass sie regulären Mustern entsprechen, sodass Computer Programme jene einlesen und interpretieren können.

3.1. Gebrauche GNU-konforme Dateinamen mit einer Basis und einer major.minor.Patch Nummerierung.

Es ist nützlich für jedermann, wenn all deine Archivdateien GNU-konforme Dateinamen besitzen -- ein Basispräfix mit alphanummerischen Kleinbuchstaben, gefolgt durch einen Bindestrich, gefolgt durch eine Versionsnummer, Dateierweiterung und weiteren Suffixen.

Lass uns die Annahme treffen, dass du ein Projekt namens `foobar' in der Version 1, Release 2, Level 3 hast. Sofern es nur ein Archiv hierzu geben sollte (wahrscheinlich die Codequellen beinhaltend), sollten der Dateiname zu nachfolgendem Beispiel konform sein:

foobar-1.2.3.tar.gz

Das Sourcearchiv

foobar.lsm

Die LSM Datei (sofern du es Metalab zur Verfügung stellst).

Gebrauche jene schlechten Beispiele nicht:

foobar123.tar.gz

Viele Programme fassen dies als ein Archiv für ein Projekt namens `foobar123' mit keiner Versionsnummer auf.

foobar1.2.3.tar.gz

Dies wiederum halten viele Programme für ein Archiv einem Projekt namens `foobar1' mit der Versionsnummer 2.3 assoziert.

foobar-v1.2.3.tar.gz

Dies wird oft von Programmen als ein Projekt namens `foobar-v1' gewertet.

foo_bar-1.2.3.tar.gz

Der Unterstrich ist für Menschen schwer auszusprechen, zu tippen und zu erinnern.

FooBar-1.2.3.tar.gz

Nur wenn du gerne wie eine Vermarktungswinzling erscheinen möchte. Dieser Dateiname ist ebenso schwer auszusprechen, zu tippen und zu erinnern.

Wenn zwischen Source und binären Archiven differenziert werden muss, zwischen verschiedenen Arten von binären Formaten oder eine Art von Buildoption im Dateinamen enthalten sein muss, dann bitte inkludiere es als Dateierweiterung nach der Versionsnummer. Einige Beispiele:

foobar-1.2.3.src.tar.gz

Sources

foobar-1.2.3.bin.tar.gz

binäre Dateien, Typ nicht spezifiziert

foobar-1.2.3.bin.ELF.tar.gz

ELF binäre Dateien

foobar-1.2.3.bin.ELF.static.tar.gz

ELF binäre Dateien, statisch gelinkt

foobar-1.2.3.bin.SPARC.tar.gz

SPARC binäre Dateien

Verwende nicht Dateinamen wie `foobar-ELF-1.2.3.tar.gz', da es Programmen die Separierung von Typusdefinitionen (wie `-ELF') von der Basis erschwert.

Ein generell gute Form von Dateiname beinhaltet folgende Elemente (der Reihe nach):

  1. Projekt Präfix

  2. Bindestrich

  3. Versionsnummer

  4. Punkt

  5. "src" oder "bin" (optional)

  6. Punkt oder Bindestrich (Punkt bevorzugt)

  7. binärer Typ und Optionen (optional)

  8. Archivierung- und Komprimierungsdateierweiterungen

3.2. Respektiere jedoch lokale Konventionen, wo sie als angemessen erscheinen

Einige Projekte und Gemeinschaften haben gründlich definierte Konventionen für Dateinamen und Versionsnummern, welche nicht zwangsläufig mit obigen Ratschlägen kompatibel sind. Beispielsweise sind Apache Module generell wie mod_foo benannt, sie haben überdies ihre eigene Versionsnummer wie auch die Version des Apache Webservers, für die sie als kompatibel befunden wurden. Perl Module haben hingegen Versionsnummern, welche gelegentlich im Fliesskommazahl-Format interpretiert werden, (die Wahrscheinlichkeit, dass man in diesem Falle 1.303 anstatt 1.3.3 sehen wird, ist vergleichsweise gross); Distributionen für eine Version 1.303 des Moduls Foo::Bar werden generell Foo-Bar-1.303.tar.gz benannt. (Auf der anderen Seite, begann Perl im Spätjahr 1999, die obig beschriebenen Konventionen zu verwenden.)

Achte auf die Konventionen von spezialisierten Gemeinschaften und Entwicklern und respektiere sie; bezüglich genereller Distribution kann man die obigen Konventionen zu Herzen nehmen.

3.3. Wähle ein einzigartes Namenspräfix, welches einfach zu tippen ist

Das Basispräfix sollte allen Projektdateien gemein sein und sollte zudem einfach zu entziffern, zu schreiben und zu erinnern sein. Also bitte vermeide Unterstriche. Und schreibe keine Buchstaben gross und benutze auch nicht mehrfache Grosschreibung innerhalb eines Namens ohne einen äusserst guten Grund -- es beeinträchtigt die natürlich menschliche Augapfel-Suchreihenfolge und erzeugt den Eindruck, dass ein Vermarkter clever zu sein versucht.

Es verwirrt Personen, wenn zwei verschiedene Projekte den gleichen Basisnamen teilen. Kläre vorab inwiefern dein Projekt mit bestehenden Namensräumen kollidiert bevor du es veröffentlichst. Einige gute Anhaltspunkte diesbezüglich liefern die Indexdatei von Metalab und der Applikatonsindex auf Freshmeat. Eine andere Möglichkeit ist SourceForge; führe dort eine Namenssuche durch.