Pre-workshop assignment: Uploading a coding project to GitHub
- Install Git and create a GitHub account
- Initialize a local git repository for your project
- Add your files to be “monitored” by git
- Commit your changes accompanied by a commit message
- Push your local project to GitHub
Software dependencies
- Recording dependencies with versions can make it easier for the next person to execute your code
- There are many tools to record dependencies
Document your research software
- Good README files provide a good landing place for anyone that is new to your project
Coding conventions and modular coding
- Coding conventions help you create more readable code that is easier to reuse and contribute to.
- Consistently formatted code including descriptive variable and function names is easier to read and write
- Software is built from smaller, self-contained elements, each handling specific tasks.
- Modular code enhances robustness, readability, and ease of maintenance.
- Modules can be reused across projects, promoting efficiency.
- Good modules perform limited, defined tasks and have descriptive names.
Further improvements to your project
- There are various ways to improve the reproducibility of your project.
Reusability check
- A check by another pair of eyes is the best way to learn how reproducible and reusable your code is