Meshinchi and Locatelli Github Contributing Guidelines
This website is for documenting how to contribute to the Meshinchi and Locatelli Lab github organization(s).
Welcome!
The goal of the lab documentation is to provide standardized procedures for creating, maintaining, and contributing to the Meshinchi and Locatelli Lab’s software and data analysis pipelines on github.
Analysis code and pipelines can be found in the lab github repository.
Objectives
Lab members will be able to understand key concepts and have standardized workflows for using:
- creating standardized
githubrepositories - using
gitcommand line utility for version control - using
githubremote repository to host code and pipelines - creating standardized
RRmarkdown and quarto documents - creating standardized
Pythonjupyter notebooks for analysis - best practices in security
- best practices in code reviews
Pre-requisites
- familiarity with
bash - familiarity using the command line
- Basic knowledge of
RandPython
Resources
Bash and using the command line interface
If you still need to gain basic working knowledge of using bash and the command line (terminal), then see the following tutorials in the resources section before following these steps.