Table of contents
Förderung bewährter Verfahrensweisen bei der Open-Source-Entwicklung
Aktivitäts-ID: GGI-A-25.
Beschreibung
Bei dieser Aktivität geht es darum, bewährte Open-Source-Verfahren innerhalb der Entwicklungsteams zu definieren, aktiv zu fördern und umzusetzen.
Als Ausgangspunkt könnten die folgenden Themen bedacht werden:
- Benutzer- und Entwicklerdokumentation.
- Ordnungsgemäße Verwaltung des Projekts in einem öffentlich zugänglichen Repository.
- Förderung und Umsetzung der kontrollierten Wiederverwendung.
- Bereitstellung einer vollständigen und aktuellen Produktdokumentation.
- Einrichtungsverwaltung: Git-Workflows, Zusammenarbeitsmuster.
- Release-Management: frühes und häufiges Freigeben, stabile Versionen im Vergleich zu Entwicklungsversionen, usw.
OSS-Projekte haben einen besonderen, [basarähnlichen]((http://www.catb.org/~esr/writings/cathedral-bazaar/) Arbeitsstil. Um diese Zusammenarbeit und Denkweise zu ermöglichen und zu fördern, werden einige Verhaltensweisen empfohlen, die eine gemeinschaftliche und verteilte Entwicklung und Beiträge von Drittentwicklern erleichtern…
Dokumente der Community
Stellen Sie sicher, dass alle Projekte innerhalb des Unternehmens die folgenden Dokumente vorschlagen:
- README – kurze Beschreibung des Projekts, wie man miteinander umgeht, Verknüpfungen zu Hilfsmitteln.
- Contributing – Einführung für diejenigen, die etwas beitragen wollen.
- Code Of Conduct – Was als Verhalten innerhalb der Gemeinschaft akzeptabel ist – und was nicht.
- LICENSE – die übliche Lizenz im Repository.
bewährte Verfahren von REUSE
REUSE ist eine Initiative der Free Software Foundation Europe zur Verbesserung der Wiederverwendung von Software und zur Vereinfachung der Einhaltung von OSS und Lizenzen.
Chancenbewertung
Obwohl es stark vom Kenntnisstand des Teams über OSS abhängt, ist es immer von Vorteil, die Mitarbeiter zu schulen und Verfahren zu schaffen die diese Verhaltensweisen durchsetzen, sind immer von Vorteil. Dies ist umso wichtiger, wenn:
- die potenziellen Nutzer und Mitwirkenden nicht bekannt sind,
- die Entwickler nicht an die Open-Source-Entwicklung gewöhnt sind.
Fortschrittsbeurteilung
Die folgenden Kontrollpunkte zeigen den Fortschritt in dieser Aktivität:
- Das Projekt legt eine Liste mit bewährten Open-Source-Verfahren fest, die einzuhalten sind.
- Das Projekt überwacht seine Ausrichtung an bewährten Verfahren.
- Das Entwicklungsteam hat ein Bewusstsein für die Einhaltung von bewährten OSS-Verfahren entwickelt.
- Neue bewährte Verfahren werden regelmäßig ausgewertet und es wird versucht, sie umzusetzen.
Werkzeuge
- Das REUSE-Hilfswerkzeug hilft dabei, ein Repository mit den bewährten Verfahren von REUSE in Einklang zu bringen. Es kann in viele Entwicklungsprozesse einbezogen werden, um den aktuellen Zustand zu bestätigen.
- ScanCode bietet die Möglichkeit, alle Gemeinschafts- und Rechtsdokumente im Repository aufzulisten: siehe Funktionsbeschreibung.
- GitHub hat eine nette Funktion, um nach fehlenden Gemeinschaftsdokumenten zu suchen. Sie ist auf der Seite Repository > “Insights” > “Community” zu finden.
Empfehlungen
- Die Liste der bewährten Verfahren hängt vom jeweiligen Umfeld und Anwendungsbereich des Programms ab und sollte regelmäßig im Sinne einer kontinuierlichen Verbesserung neu bewertet werden. Die Maßnahmen sollten überwacht und regelmäßig bewertet werden, um Fortschritte zu verfolgen.
- Schulung von Menschen über die Wiederverwendung von OSS (als Konsumenten) und Ökosystemen (als Beitragende).
- Setzen Sie REUSE.software wie in Aktivität #14 um.
- Richten Sie ein Verfahren zum Umgang mit rechtlichen Risiken im Zusammenhang mit Wiederverwendung und Beiträgen ein.
- Ermutigen Sie die Mitarbeiter ausdrücklich, zu Fremdprojekten beizutragen.
- Stellen Sie eine Vorlage oder offizielle Richtlinien für die Projektstruktur bereit.
- Richten Sie automatische Kontrollen ein, um sicherzustellen, dass alle Projekte die Richtlinien einhalten.
Hilfsmittel
- OW2’s list of open source best practices aus der Methodik zur Bewertung der Marktreifegrade.
- REUSEs offizielle Website mit Spezifikationen, Tutorial und FAQ.
- Gemeinschaftsrichtlinien von GitHub.
- Ein Beispiel für bewährte Verfahren für die Einrichtungsverwaltung mit GitHub.
Empfohlene nächste Aktivitäten
- GGI-A-42 - Verwalten von Open-Source-Fähigkeiten und -Ressourcen Sie können die Liste der bewährten Praktiken für die Open-Source-Entwicklung zu den allgemeinen Schulungsunterlagen hinzufügen.
- GGI-A-44 - Codeüberprüfungen durchführen Code-Reviews sind ein wesentliches Merkmal bewährter Entwicklungsverfahren.