search

OpenEnergyPlatform / academy

The Open Energy Academy is a collection of courses, tutorials, and questions for the Open Energy Family
https://openenergyplatform.github.io/academy/
GNU Affero General Public License v3.0
16 stars 6 forks source link

Tutorial: How to document #51

Closed klarareder closed 3 years ago

klarareder commented 5 years ago

How to work with Issues, and document the code

christian-rli commented 3 years ago

Is this really done best in a tutorial or should it be a good self-description in the repository with template issues and so on?

christian-rli commented 3 years ago

Working with issues and documenting code are both vast topics. Working with issues, put most simply, follows the github workflow. How to document code depends very much on the repository and what was edited. This issue isn't formulated clearly. Therefore closing it.