10. GitHub website

Wat is GitHub?

Hiervoor is GitHub vaker benoemd. Github is een online platform voor softwareontwikkeling en versiebeheer dat voornamelijk is gebaseerd op Git. GitHub voegt een online interface toe aan Git, waardoor teams eenvoudiger kunnen samenwerken aan projecten en wijzigingen kunnen delen.

GitHub biedt naast de online interface nog meerdere zaken aan waarmee de samenwerking in een team beter kan verlopen.

Issues

Met issues kunnen zaken, zoals problemen, features en bugs, binnen een repository worden bijgehouden en aan gewerkt worden.

Bij issues kunnen verschillende dingen gedaan worden:

• Commenten
  • Er kunnen comments geplaatst worden op issues zodat een issue correct kan worden afgehandeld.

Op de GitHub website in een repository kunnen de issues gevonden worden onder het kopje Issues. Voor het maken van een issue moet er op de groene New Issue knop gedrukt worden. Figuur 1: Issue pagina op GitHub website

Eenmaal in dat scherm zijn dit de opties:

• Title
• Description
  • Hierin kan je werken met markdown
• Assignees
  • Er kunnen mensen geassigned worden op een issue. Hiermee kan duidelijk worden aangegeven wie verantwoordelijk is om een issue op te lossen.
• Labels
  • Met labels kan er een overzicht worden gegeven wat voor een soort issue er beschreven wordt. Figuur 2: Pagina voor het aanmaken van een issue

Voor meer informatie: GitHub Issues

Wiki

Een GitHub Wiki is een systeem dat geïntegreerd is in GitHub-repositories en waarmee je documentatie voor je project kunt maken en organiseren. Het werkt als een kleine website waar je meerdere pagina’s kunt aanmaken, deze aan elkaar kunt koppelen en de inhoud kunt opmaken met markdown.

Het wordt vaak gebruikt om gedetailleerde documentatie voor een project aan te bieden, zoals installatiehandleidingen, gebruiksinstructies, API-referenties en veelgestelde vragen.

Je kunt de wikipagina’s opmaken met markdown, een eenvoudige opmaaktaal, zodat je makkelijk tekst kunt stylen en elementen zoals codefragmenten, links en afbeeldingen kunt toevoegen.

Net als bij een GitHub-repository, kunnen medewerkers aan de repository ook de wikipagina’s bewerken, afhankelijk van hun rechten.

Elke wijziging in een wiki wordt bijgehouden, zodat je de geschiedenis van bewerkingen kunt zien, veranderingen kunt vergelijken en indien nodig kunt terugkeren naar eerdere versies.

Om gebruik te maken van de wiki is deze te vinden in dezelfde taskbar waar de Issues ook te vinden is.

Meer informatie over de Wiki: GitHub Wiki

Project

GitHub Projects is een tool binnen GitHub die helpt bij het organiseren en beheren van werk voor een repository of organisatie. Het biedt een visueel overzicht van taken en workflows, vergelijkbaar met een projectmanagementbord zoals Trello. Het is ontworpen om ontwikkelteams te helpen hun werk beter te plannen en te volgen. Figuur 3: Project pagina op de GitHub website

Meer informatie over Projects: GitHub Projects

Pages

GitHub Pages is een dienst van GitHub waarmee je eenvoudig statische websites kunt hosten vanuit een GitHub-repository. Het is bedoeld voor het maken van persoonlijke websites, projectdocumentatie, of portfolio’s zonder dat je zelf een webserver hoeft te beheren.

GitHub Pages ondersteunt HTML-, CSS-, en JavaScript-bestanden kunt hosten voor een statische website. Je kunt ook gebruikmaken van statische site generators om dynamische content te maken zonder een server-side backend.

Standaard zal de url voor de GitHub page gebruikersnaam.github.io worden. De hosting op pages is ook een gratis service.

Om een eigen GitHub Page aan te maken, volg dit stappenplan

Meer informatie over Pages: GitHub Pages

Releases

GitHub Releases zijn een manier om versies van je softwareproject te beheren en te delen via GitHub. Releases zijn nauw verbonden met tags en bieden een gestructureerde manier om belangrijke punten in de ontwikkeling van een project te documenteren, zoals nieuwe versies, bugfixes of belangrijke veranderingen.

Een release op GitHub is gekoppeld aan een specifieke tag in je repository. Wanneer je een release maakt, wijs je deze toe aan een tag die een snapshot van je project op dat specifieke moment vertegenwoordigt.

Releases zijn zichtbaar op de GitHub-pagina van je repository en zijn toegankelijk voor iedereen die toegang heeft tot de repository. Dit maakt het eenvoudig voor andere ontwikkelaars en gebruikers om te zien welke versies beschikbaar zijn en welke veranderingen zijn aangebracht.

Voordelen van GitHub Releases

• Overzichtelijkheid: Releases bieden een georganiseerde manier om de voortgang van je project te volgen.
• Gebruiksgemak: Gebruikers kunnen eenvoudig de nieuwste versies van je software downloaden en installatie-instructies bekijken.
• Documentatie: De release-notities fungeren als documentatie voor wat er in elke versie is veranderd.
• Automatisering: GitHub kan geïntegreerd worden met CI/CD-tools om automatisch releases te maken wanneer bepaalde voorwaarden zijn voldaan.

Meer informatie over Releases: GitHub Releases

Bronnen

Github Issues: https://github.com/features/issues
Github Wiki: https://docs.github.com/en/issues/planning-and-tracking-with-projects
Github Project: https://docs.github.com/en/issues/planning-and-tracking-with-projects
Github Pages: https://docs.github.com/en/pages
Github Tags: https://git-scm.com/book/en/v2/Git-Basics-Tagging
Github Releases: https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases