Grading Rubric for GitHub

Rubric for GitHub (100 points, 30% of the final project grade)

Category	Criteria	Points
Code Quality	Quality and functionality of the scripts and code	25
	The code is clean, well-documented, and follows good programming practices
	All scripts run without errors (when the environment is properly set up)
	Code is modular, with reusable functions where appropriate
	Scripts achieve the intended outcomes (e.g., generating plots, performing analysis)
Reproducibility	Ease of reproducing the analysis and results	25
	The repository includes clear instructions (e.g., in a README.md) for setting up the environment and running the code
	Jupyter notebooks, scripts, and any other files necessary to recreate the analysis are provided
	Data (or instructions to access data) are included or referenced appropriately
	Output (plots, tables) are reproducible using the code
Organization & Structure	Organization and clarity of the repository structure	20
	Repository is well-organized with clear folder structure (e.g., separate folders for code, data, results, etc.)
	File and folder names are descriptive and intuitive
	README file provides a clear overview of the repository and how to navigate it
Documentation	Clarity and completeness of documentation	15
	README file clearly explains the project, dependencies, and setup instructions
	Code and notebooks are well-documented, including comments explaining key sections
	Scripts include docstrings for functions and appropriate inline comments
Environment Setup	Provision of environment setup and dependency management	10
	Includes a complete and working conda environment file (environment.yml) or requirements.txt for virtual environments
	Environment file lists all necessary dependencies with correct versions
	Instructions for setting up the environment are clear and easy to follow
Version Control Practices	Effective use of Git and GitHub features	5
	Commits are frequent, descriptive, and reflect the progression of the project
	Clear use of branches, if applicable (e.g., for different features or phases of the project)
	Issues, pull requests, or other GitHub collaboration tools are used effectively