Skip to content

Changes

Page history
Update development guidelines authored by Lukas Altenhuber's avatar Lukas Altenhuber
Show whitespace changes
Inline Side-by-side
development-guidelines.md
View page @ ff952134
...@@ -38,4 +38,4 @@ Releases have to be tagged with a version number tag ```v0.1.0``` within the mas ...@@ -38,4 +38,4 @@ Releases have to be tagged with a version number tag ```v0.1.0``` within the mas
To document your work is a very important thing. Try to think about, what is important for a newbee to get started with your code. Always document which functionality is working, which bugs are known and what is not working. Also explain the main ideas behind your code to get started easier. To document your work is a very important thing. Try to think about, what is important for a newbee to get started with your code. Always document which functionality is working, which bugs are known and what is not working. Also explain the main ideas behind your code to get started easier.
For documentation use the `README.md` within your project. If you have a more complex documentation work, use the Wiki of the Project. For documentation use the `README.md` within your project. If you have a more complex documentation work, use the Wiki of the Project.
Here is a [Template](https://ressel.fh-salzburg.ac.at/ENOSAR/Framework/blob/feat/460/enoceanDocu/service/io/org.enosar.service.io.enocean/readme.md) for the `README.md` Here is a [Template](https://ressel.fh-salzburg.ac.at/ENOSAR/Framework/blob/master/service/io/org.enosar.service.io.enocean/readme.md) for the `README.md`