Skip to content

CRAWlab/CRAWLAB-Internal-Reporting-Template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 

Repository files navigation

CRAWLAB Internal Reporting Markdown Template

This repository contains the Markdown template for individual researcher reports internal to the lab.

Reporting Instructions

Please create a top-level folder in your personal GitHub folder named "Internal Reporting". Then, for each report, create a sub-folder with that one named 20xx_mm_dd_Lastname. Name the .md file for the report within that folder similarly, 20xx_mm_dd_Lastname.md.

I will watch for the sync notification to see that you're ready for me to review. Please make the commit message for the review-ready version: "Ready for Review - 20xx_mm_dd Report". That way I don't start looking at a version that's just a draft.

I will sync my comments with a commit message of "Comments for Lastname - 20xx_mm_dd Report". Each comment with be prepended with > ***JV*** which will make it a block quote with my initials in bold italic.

To respond to comments, do a similar thing. Make the response(s) directly on the report .md file, prepending your comment(s) with > ***YourInitials***. Sync the response with a commit message of "Discussion Ready - 20xx_mm_dd Report".

About

CRAWLAB Internal Reporting Markdown Template

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published