We value the Agile Manifesto and the Manifesto for Software Craftsmanship.
See also resources.
Documentation
Markdown (Markdown Guide, Heise) is the standard interchange format for textual information, as it is supported by Zulip, Nextcloud, Forgejo and many more tools. Try Loqseq as an easy-to-use local Markdown editor.
Graphical documentation should be created with PlantUML and shared as SVG while providing the source code whereever possible.
Please write documentation with Semantic Linebreaks for better maintainability: https://sembr.org/
Code
Kull Convention is the base for development collaboration.
We encourage Readme Driven Development and expect Test Driven Development for all serious projects. Create Documentation while working, not as an afterthought.
We strive to use recent yet established, stable and efficient technologies, providing as much accessibility as feasible by leveraging pre-built, tested components. No human should be unnecessary excluded from what we create. This entails researching the appropriate tools and programming languages before starting.
Further Readings:
- https://guides.lib.berkeley.edu/how-to-write-good-documentation
- https://www.writethedocs.org/guide/docs-as-code/
Code Standards
- no files and commits over 200 lines
- commit messages descriptive in imperative mood according to https://cbea.ms/git-commit
If you are about to write an enumeration into the commit message which lists the changes you have done, stop and split the commit.
The commit message body should only explain the WHY and/or HOW. If the title does not suffice to summarize the WHAT, your commit is too big.