docs/reference/.github/ISSUE_TEMPLATE/documentation.md

In aclu-national/LibLabReviews: Encourage Effective Peer Review Practices with Useful Tooling

name: Documentation about: Ensuring that code especially completed projects are well documented title: '[Documentation] [ISSUE TITLE]' labels: 'Documentation :pencil:'

Documentation Issue(s) Checklist

• [ ] READMEs are up-to-date and comprehensive about the file structures and content
• [ ] A project scoping document exists and has been updated with changes and assumptions made
• [ ] All functions are fully documented
• [ ] All markdown documents contains relevant text and all scripts contain needed comments
• [ ] Commits / PR Requests are clear and concise
• [ ] Are the parts of analysis done by hand (eg spreadsheet manipulation) very precisely documented and split out from the raw inputs?
• [ ] Is the purpose and location of every file and function clearly documented somewhere (eg README)

Must Fixes

Suggestions

References

Context (Environment)

Reprodicibility Recceipt

# Datetime
Sys.time()

# Repo
git2r::repository()

# Session Info
sessioninfo::session_info()

aclu-national/LibLabReviews documentation built on Aug. 20, 2020, 7:23 a.m.