How_to_developers_report - TuxML/ProjetIrma GitHub Wiki

How to write and publish your report

Basics guidelines

  1. Name your report with the format YY_MM_DD_name.md
  2. Try to be concise enough : your report isn't a log diary!
  3. Try to follow a clear structure :
    • introduction (current state)
    • problems
    • proposition/search result
    • conclusion
  4. All reports and reports' dependencies belong to the developers_report/reports directory.

Tips and trick

  • If you want to add an image use the markdown command ![name](link). If your image have to be added in the wiki, the link begin with https://raw.githubusercontent.com/wiki/TuxML/ProjetIrma/ by the path inside the wiki repository.
⚠️ **GitHub.com Fallback** ⚠️