Open source werken heeft veel voordelen. Maar hoe ziet de codebase van een gezond open source project er uit? En waar moet je nog meer rekening mee houden? Antwoorden daarop krijg je in dit artikel.
Wat zijn de minimale eisen?
Om een Open Source project bruikbaar te maken heb je in ieder geval een aantal dingen nodig:
- Een readme
(README.md)
- Een gedragscode
(CONTRIBUTING.md)
- Een licentie
(LICENSE)
- Een
publiccode.yml
Handige andere bronnen
Project Launch Checklist
Als je er achter wilt komen of het haalbaar is om je project te open sourcen is de “Project Launch Checklist” van OSPO-NL een handig naslagwerk. Ook helpt dit document je bij het toegankelijk maken van jouw codebase voor eventuele contributers.
Standard for Public Code
Om meer te weten te komen over de dagelijkse processen rondom een open source codebase is de “Standard for Public Code” zeer geschikt. Deze vind je hier:
Opensource.guide
Dit project is gestart en wordt onderhouden door Github. Het is net zoals de Standard for Public Code opgericht om te helpen bij het succesvol open source maken van projecten. Je vindt hem hier: