Bugs en problemen indienen

From Joomla! Documentation

Revision as of 20:46, 28 September 2014 by MarijkeS (talk | contribs) (Created page with "Schrijf volledige, reproduceerbare, specifieke bug rapporten. Geef zoveel mogelijk informatie, compleet met code snippets, test cases, etc. En voorbeeld die de bug illustreert...")
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Nederlands • ‎Türkçe • ‎català • ‎eesti • ‎español • ‎français • ‎italiano • ‎português • ‎svenska • ‎Ελληνικά • ‎русский • ‎অসমীয়া • ‎中文(台灣)‎ • ‎日本語

Om een bug te melden op de Joomla! bug trackers moet er een tracker item gemaakt worden. Nadat het tracker item is gemaakt zullen de ontwikkelaars onderzoeken of de melding klopt en de nodige handelingen verrichten.

Bugs melden

Registreer een account op GitHub

U zult zich moeten registreren op GitHub; de Joomla! issue tracker gebruikt GitHub accounts als verificatie.

Toegang tot de Joomla! issue tracker.

Controleer of het probleem dat u wilt melden al is gemeld.

Een serie filters geven de tracker items weer, door op de "zoekmiddelen" te klikken worden de filters geopend. Door met de muis over de titel te bewegen kan de inhoud bekeken worden. Wanneer het probleem dat u ondervindt nog niet is gemeld kunt u op de knop "Nieuw issue" klikken in de hoofdnavigatie.

Er wordt een nieuw venster weergegeven, hoe meer informatie u daar geeft, hoe beter het is voor de ontwikkelaars

Vul zoveel mogelijk gegevens in. U kunt tips voor ieder veld inschakelen door te schakelen tussen Pro en Help voor de "Toon modus" aan de rechter kant van het venster.

  • Prioriteit : Gebruik de standaard "Gemiddeld" tenzij u voldoende bekend bent met de code om een andere keuze te maken.
  • Versie : Vul hier de versie(s) in waarop het probleem van toepassing is
  • Categorieën : Dit is lastiger. Gebruik "Administration" wanneer u het niet weet.
  • Titel : Een korte samenvatting van het probleem.
  • Omschrijving : Gegevens van het probleem. Zie het gedeelte hieronder voor meer informatie.
  • Uploaden : Het is toegestaan om afbeeldingen te uploaden bij het melden van een probleem. Informatie over de upload vereisten worden vermeld op het formulier.

Geen een samenvatting

Beschrijf in een paar woorden de problemen die u ondervindt. Het is over het algemeen een goed idee gebruik te maken van bestaande tracker items wanneer dit de eerste keer is dat u een probleem meldt.

Voorbeelden:

  • Website: Waarschuwing zo en zo.
  • Beheergedeelte: Kan het artikel niet opslaan wanneer "naamvandeplugin" is gepubliceerd.

Opmerking: zorg voor een duidelijke beschrijving van het probleem in de samenvatting, dit is het eerste wat ontwikkelaars zien wanneer zij de tracker doorzoeken op problemen die opgelost moeten worden.

Geef informatie over het probleem

Om zoveel mogelijk informatie te geven is het veld voor de beschrijving door middel van een template ingedeeld in vijf subsecties:

  • Stappen om het probleem te reproduceren : Gedetailleerde stappen die beschrijven hoe iemand anders het probleem kan reproduceren.
  • Verwacht resultaat : Hetgeen verwacht werd na het uitvoeren dan de bovenstaande stappen.
  • Het werkelijke resultaat : Wat er werkelijk gebeurd bij het uitvoeren van de bovenstaande stappen
  • Systeem informatie : Informatie over de omgeving van waarin uw systeem is geconfigureerd. Dit kan onder meer de browser die u gebruikt, de PHP versie van uw server, of het type database van uw site inhouden. Voor optimale resultaten, kunt u deze gegevens kopiëren van de weergave systeeminformatie wanneer u bent aangemeld in het beheergedeelte van uw website.
  • Extra opmerkingen: Elke informatie die niet in de bovenstaande velden is gegeven maar kan bijdragen aan het oplossen van het probleem.

De algemene opmaak zou iets moeten zijn als:

  1. "Dit is wat ik precies gedaan heb."
  2. "Dit is wat er gebeurd is."
  3. "Dit is wat ik denk wat er had moeten gebeuren."
  4. "Overige informatie, mogelijke oplossing, voorgestelde code patch."

Hoe meer informatie, hoe beter. Het is ook belangrijk om het probleem te kunnen reproduceren met gebruik van een Joomla! website met testvoorbeelddata, of met gemakkelijke, duidelijke instructies voor het opzetten ervan. Vergeet niet day anderen geen toegang hebben tot de database van uw website, u moet dus in staat zijn om iemand uit te leggen hoe het probleem gezien kan worden met de data die beschikbaar is -- de voorbeeld website.

Voorbeeld A

Wat ik heb gedaan
Ik begon met de voorbeeld website. Alles was normaal. Ik heb de "naamvanplugin" ingeschakeld. Ik probeer een artikel in het beheergedeelte op te slaan.
Wat er gebeurd
Ik krijg een leeg scherm en het artikel is niet opgeslagen.
Wat er zou moeten gebeuren
Artikel zou correct opgeslagen moeten worden.
Overige informatie
Deze plugins zijn ingeschakeld op hetzelfde moment. SEF is ingeschakeld (of uitgeschakeld). Mijn website staat in een submap. Verder merk ik op dat ... etc. Volgens mij zijn die en die bestanden de oorzaak (wanneer u weet waarover u praat).

Voorbeeld B

Wat ik heb gedaan
Ga naar het beheergedeelte. Klik op "menu-naam" Menu.
Wat er gebeurde
Pagina die geopend werd is leeg.
Wat er had moeten gebeuren
Menu had normaal geopend moeten worden.
Overige informatie
Alle andere menu's werken normaal. etc.

Daadwerkelijk voorbeeld

  • Wat ik heb gedaan
  1. Begonnen met de voorbeeld website.
  2. Een ongepubliceerd artikel toegevoegd via het beheergedeelte, in sectie=FAQ, categorie=algemeen.
  3. In de opties voor het artikel zijn Toon titel op "Nee" en Printen, PDF en e-mail iconen op "Verberg" ingesteld.
  4. Sla het artikel op en ga naar de website. Log-in op de website als administrator en ga naar Example Pages -> Category Blog menu-item.
  • Wat er gebeurde: Het nieuw toegevoegde artikel werd weergegeven maar er is geen bewerk-icoon voor de website gebruiker om op te klikken.
  • Wat er had moeten gebeuren: Het bewerk-icoon zou weergegeven moeten worden waarmee de website gebruiker het artikel bewerken kan.
  • Overige informatie: Dit doet zich alleen voor met de rhuk_milkyway template. Door deze code [voorgestelde code] te wijzigen in bestand [naam en hiërarchie van het bestand], regel(s) #, lijkt het probleem voor mij opgelost te zijn.

Een pull request direct via Joomla!'s GitHub archief indienen

Wanneer u een voorstel als oplossing wilt indienen door de code in Joomla! zelf aan te bieden kunt u dat doen door middel van een "pull request" naar Joomla!'s code repository op GitHub.com, die u hier kunt vinden: https://github.com/joomla/joomla-cms

Dit proces vereist enige kennis van Source Control Management systemen en Git in het bijzonder. Indien u weet wat de Git SCM is en hoe het werkt, is het proces eenvoudig:

  • Aanmelden voor een gratis GitHub.com account
  • Fork de Joomla! repo
  • Schakel over naar de "staging" branch wanneer u een oplossing wilt voorstellen voor de huidige Joomla! 3.x release of naar de "2.5.x" branch wanneer u een oplossing wilt voorstellen voor Joomla! 2.5.
  • De gerelateerde bestanden in Joomla! in de juiste branch toevoegen/bewerken en klik op de knop "review & compare" - meer informatie hierover op https://help.github.com/articles/using-pull-requests - om het proces van het indienen van de "pull request" te starten.

Extra tips and trucs

Goed geschreven bug rapporten zijn ongelooflijk nuttig. Er is echter sprake van een zekere mate van overhead bij het werk op een ieder bug tracking systeem, uw hulp bij het zoveel mogelijk nuttig houden van ons ticketsysteem wordt dus gewaardeerd. In het bijzonder:

  • Do read the FAQ to see if your issue might be a well-known question.
  • Doorzoek altijd de tracker om te controleren of uw probleem al is gemeld.
  • Vraag eerst op het testforum wanneer u niet zeker weet of datgene wat u ondervindt een bug is.
  • Schrijf volledige, reproduceerbare, specifieke bug rapporten. Geef zoveel mogelijk informatie, compleet met code snippets, test cases, etc. En voorbeeld die de bug illustreert in een kleine test case is het beste.
  • Don't use the tracker system to ask support questions. Use the Joomla! forums, or the #joomla IRC channel on freenode for that.
  • Don't use the trackers to make large-scale feature requests. We like to discuss any big changes to Joomla!'s core on the developers forums before actually working on them.
  • Don't reopen issues that have been marked "not a bug". This mark means that the decision has been made that we can't or won't fix this particular issue. If you're not sure why, please ask on developer forums.
  • Don't use the tracker for lengthy discussions, because they're likely to get lost. If a particular tracker item is controversial, please move discussion to developer forums.

Veiligheidsproblemen melden

Meld veiligheidsproblemen aan security [at] joomla [punt] org. Dit is een besloten lijst waar alleen ontwikkelaars die al lange tijd bijdragen en betrouwbaar zijn toegang toe hebben.

Wanneer de kwetsbaarheid bevestigd wordt in Joomla! zelf, zullen de volgende acties ondernomen worden:

  • De melder wordt op de hoogte gebracht van de ontvangst van het rapport en dat er gewerkt wordt aan een oplossing. Er wordt een ruwe tijdschatting gegeven en de melder wordt gevraagd het probleem niet openbaar te maken voordat het door het project wordt aangekondigd.
  • Alle andere ontwikkelingen worden zo lang als nodig stopgezet voor het ontwikkelen van een oplossing, met inbegrip van patches tegen de huidige en de twee voorgaande versies.
  • Een datum waarop het veiligheidsprobleem wordt aangekondigd wordt bepaald. Om een wedloop tussen degenen die de patch toepassen en die proberen misbruik te maken van het lek, worden veiligheidsproblemen niet onmiddellijk aangekondigd.
  • Publieke aankondiging van het veiligheidsprobleem en de oplossing op de vooraf vastgestelde datum. Dit zal waarschijnlijk een nieuwe vrijgave van Joomla! betekenen maar in sommige gevallen kan het eenvoudig een patch tegen de huidige vrijgaven zijn.