4.3 KiB
4.3 KiB
Bijdragen aan Electron
📝 Beschikbare vertalingen: Koreaans | Versimpeld Chinees | Braziliaans Portugees | Nederlands
👍🎉 Ten eerste, bedankt om de tijd te nemen om bij te dragen! 🎉👍
Dit project volgt de gedragscode van bijdragers. Door deel te nemen, wordt je verwacht je aan deze code te houden. Onaanvaardbaar gedrag moet gerapporteerd worden bij atom@github.com.
Dit is een set van richtlijnen om bij te dragen aan Electron. Dit zijn slechts richtijnen, geen regels, gebruik je gezond verstand voe je vrij om wijzigingen aan dit document voor te stellen in een pull request.
Issues indienen
- Je kan hier een issue indienen,
maar lees eerst onderstaande suggesties en voeg zo veel mogelijk details toe bij je indiening. Indien mogelijk, voeg dan toe:
- De versie van Electron die je gebruikt
- Het besturingssysteem dat je gebruikt
- Indien mogelijk, wat je aan het doen was toen het probleem zich voor deed en wat je verwachtte dat zou gebeuren
- Andere dingen die kunnen helpen bij het oplossen van je probleem:
- Schermafbeeldingen en geanimeerde GIFs
- Foutmeldingen die voorkomen in je terminal, ontwikkeltools of als melding
- Doe een vluchtig onderzoek om te zien of een gelijkaardig probleem al is gemeld
Pull Requests Indienen
- Voeg screenshots en geanimeerde GIFs toe in je pull request wanneer mogelijk.
- Volg de JavaScript, C++ en Python codeer-stijl gedefinieerd in de documentatie.
- Schrijf documentatie in in Markdown. Zie de Documentatie Stijlgids.
- Gebruik korte commit-berichten in de tegenwoordige tijd. Zie Commit Bericht Stijlgids.
Stijlgidsen
Code
- Beëindig bestanden met een newline.
- Requires in de volgende volgorde:
- Ingebouwde Node Modules (zoals
path
) - Ingebouwde Electron Modules (zoals
ipc
,app
) - Lokale Modules (met relatieve paden)
- Ingebouwde Node Modules (zoals
- Klasse-properties moeten in volgende volgorde:
- Klasse-methodes en properties (methodes starten met
@
) - Instance-methodes en properties
- Klasse-methodes en properties (methodes starten met
- Vermijd platform-afhankelijke code:
- Gebruik
path.join()
om filenames te concateneren. - Gebruik
os.tmpdir()
in plaats van/tmp
voor de tijdelijke directory.
- Gebruik
- Gebruik een gewone
return
wanneer je expliciet uit een functie returned.- Geen
return null
,return undefined
,null
, ofundefined
- Geen
Git Commit Berichten
- Gebruik tegenwoordige tijd ("Add feature" niet "Added feature")
- Gebruik gebiedende wijs ("Move cursor to..." niet "Moves cursor to...")
- De eerste lijn mag maximum 72 karakters lang zijn
- Refereer uitvoerig naar issues en pull requests
- Wanneer je enkel documentatie wijzigt, voeg dan
[ci skip]
toe aan het commit-bericht - Wanneer toepasbaar, begin je commit-bericht met volgende emoji:
- 🎨
:art:
als het formaat/de structuur van de code wordt verbeterd - 🐎
:racehorse:
als de performantie van de code wordt verbeterd - 🚱
:non-potable_water:
als memory leaks worden opgelost - 📝
:memo:
als documentie is geschreven - 🐧
:penguin:
als er iets Linux-gerelateerd is opgelost - 🍎
:apple:
als er iets macOS-gerelateerd is opgelost - 🏁
:checkered_flag:
als er iets Windows-gerelateerd is opgelost - 🐛
:bug:
als een bug is opgelost - 🔥
:fire:
als code of bestanden worden verwijderd - 💚
:green_heart:
als de CI build wordt gefixt - ✅
:white_check_mark:
als er tests worden toegevoegd - 🔒
:lock:
als er iets met security wordt gedaan - ⬆️
:arrow_up:
als dependencies worden geüpgraded - ⬇️
:arrow_down:
als dependencies worden gedownpgraded - 👕
:shirt:
als linter waarschuwingen worden opgelost
- 🎨