Documentatie · Ontwikkelaarsdocumentatie
Richtlijnen voor bijdragen
Deze pagina legt uit hoe u op een publieksveilig niveau wijzigingen kunt bijdragen aan de plugin. Interne klassennamen, interne constanten en verwijzingen naar private release-infrastructuur worden hier niet gepubliceerd.
Wanneer u dit document moet gebruiken
Lees dit document wanneer u van plan bent om:
- Een pull request te openen dat een bug oplost, een functie toevoegt of de documentatie verbetert.
- De plugin naar een nieuwe taal te vertalen.
- Een beveiligingsrapport in te dienen.
Overzicht
Bijdragen worden geaccepteerd via pull requests. Elke wijziging moet:
- Overeenkomen met de bestaande structuur en conventies (zie Coding Standards).
- Waar mogelijk gedekt zijn door unit-tests (zie Testing Guide).
- Vertaalbare strings bevatten die het textdomain van de plugin gebruiken (zie Internationalization For Developers).
- De juiste sanitisation en escaping toepassen (zie Sanitization And Escaping) en het overkoepelende beveiligingsmodel respecteren (zie Security And Capability Checks).
- De relevante documentatie onder
docs/en/bijwerken wanneer openbaar waarneembaar gedrag verandert — en die documentatie publieksveilig houden.
Vereisten of randvoorwaarden
- Git lokaal geïnstalleerd en een fork van de repository.
- De PHP- en WordPress-versies zoals aangegeven in de plugin-header.
- Composer geïnstalleerd voor ontwikkelingsafhankelijkheden (alleen voor het testframework).
- Een werkende lokale WordPress-installatie om wijzigingen te valideren die verder gaan dan logica die met unit-tests getest kan worden (zie Local Development Setup).
Stapsgewijze instructies
- Fork de repository en maak een feature-branch aan.
- Breng uw wijziging aan. Volg de richtlijnen voor publieksveilig schrijven bij het bijwerken van documentatie: voeg geen interne klassennamen, optiesleutels, REST/AJAX-routenamen, cron-hooknamen, capability/nonce-ID's of details over de release-infrastructuur toe aan de gepubliceerde
docs/-set. - Voeg waar mogelijk unit-tests toe of werk deze bij.
- Voer de testsuite lokaal uit voordat u het pull request opent.
- Open een pull request vanaf uw branch. Beschrijf de wijziging, de tests die u hebt uitgevoerd en eventuele updates aan de documentatie.
Beveiligingsrapporten
Als u denkt een beveiligingsprobleem te hebben ontdekt, open dan geen openbare issue. Neem privé contact op met AD Promotion, zodat het rapport kan worden beoordeeld en opgelost voordat het openbaar wordt gemaakt.
Vertalingen
Als u een vertaling wilt bijdragen, baseer uw werk dan op het POT-bestand van het project onder /languages en dien uw .po- / .mo-bestanden in via het normale pull-request-proces. Zie Internationalization For Developers.
Kennisgeving openbare documentatie. Deze pagina biedt uitsluitend een globaal integratieoverzicht. Interne implementatiedetails, private API's, opslaginterne zaken en beveiligingsgevoelige release-infrastructuur worden afzonderlijk beheerd en maken geen deel uit van de openbare documentatie.