-
Notifications
You must be signed in to change notification settings - Fork 6
Suggested use of Documentation and Wikis in Velocitas
Erik Jaegervall (Jägervall) edited this page Oct 14, 2024
·
1 revision
- User-oriented documentation (How to use the Velocitas) shall preferably be documented in this repository (i.e. not in the wiki)
- Generic information for developers (contributors, committers) of Velocitas shall preferably be documented in this wiki
- This concerns for example design/style guides, general design for Github actions and similar
- Also generic information concerning testing and release management, for example Velocitas license checking concepts
- Repository-specific information may be documented in the wiki for that repository. Example topics:
- How to create a release/tag
- Which files to update before doing a release (if any)
- How to update dependencies