Minimum useful README
- What question does this project answer?
- What data are used?
- Which script or notebook should run first?
- Who maintains it?
Using GitHub as a practical home for scripts, notes, figures, and project coordination
Git is the version-control system. GitHub is the cloud platform built around it.
Good repo size: one coherent analysis, class assignment, tool, or paper project.
Avoid one giant repository for every script you have ever written.
A good commit message says what changed in plain language.
Update amphibian cleaning filter
Removed records with coordinate uncertainty over 10 km and regenerated occurrence map.
Some occurrence points are valid but receive NoData after clipping. Need to inspect whether this is coastline mismatch or coordinate uncertainty.
bug/question raster assignment-05Use issues for tasks, questions, bugs, ideas, and decisions you do not want to lose.
"Map broken."
"The Maine amphibian map renders points in the ocean after reprojection. I expected points to stay within the state boundary. See notebook cell 14."
A useful issue includes context, expected result, actual result, and next step.
Kind of work: data, figure, bug, writing, question.
Who is responsible for the next action?
Group work for a deadline, assignment, poster, or manuscript.
You do not need to master pull requests on day one.
But they are useful when collaborators want to review changes before merging them into the main project.
For solo class work, commits on main may be enough. For collaboration, branches become more useful.
A named version of your repository, such as the analysis used for a manuscript.
Tells others how to cite your code or project.
States what others are allowed to do with your code.
Use `.gitignore` to keep files out of the repository.
Use the features that solve real research problems. You do not need all of GitHub at once.