https://github.com/rise-unibas/clean-code
Training materials and slides for courses on version control, clean code and documentation with practical examples and exercises in Python and R
https://github.com/rise-unibas/clean-code
clean-code documentation fair4rs git python r training-materials versioning
Last synced: 5 months ago
JSON representation
Training materials and slides for courses on version control, clean code and documentation with practical examples and exercises in Python and R
- Host: GitHub
- URL: https://github.com/rise-unibas/clean-code
- Owner: RISE-UNIBAS
- License: cc-by-4.0
- Created: 2023-01-27T13:02:49.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-08-25T09:05:08.000Z (9 months ago)
- Last Synced: 2025-09-04T20:52:30.024Z (9 months ago)
- Topics: clean-code, documentation, fair4rs, git, python, r, training-materials, versioning
- Language: HTML
- Homepage:
- Size: 16.8 MB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
# Version control, clean code and documentation
Comprehensive training materials for teaching researchers how to write maintainable, well-documented code and collaborate effectively using version control. Includes crash courses and a full 4-day course with practical examples in Python and R, plus AI-assisted coding workflows.
[](https://doi.org/10.5281/zenodo.15099964)
## What's Included
- **Full 4-day course** (15+ hours) covering Git, GitHub, clean code principles, documentation, AI-assisted coding, and research data publishing
- **Quick crash courses** (3-6 hours) for focused topics
- Hands-on exercises and real-world examples in Python and R
- Ready-to-use slides and materials for instructors
- New for 2026: AI-assisted coding session with Claude Code and PyCharm
## Creator
These materials were created by the University of Basel's Research and Infrastructure Support RISE (rise@unibas.ch) between 2023 and 2026.
## Documentation
[Read this file on GitHub pages](https://rise-unibas.github.io/clean-code/).
## Course Variants
Note that there are [different versions of this course](https://github.com/RISE-UNIBAS/clean-code/releases), see the [changelog](CHANGELOG.md) for details.
### Full 4-Day Course
**[Course on version control, clean code and documentation](course/README.md)** in [`clean-code/course`](https://github.com/RISE-UNIBAS/clean-code/tree/main/course)
Comprehensive 4-day hands-on course (15+ hours) covering:
- Git and GitHub fundamentals
- Clean code principles and file organization
- Documentation with Sphinx and docstrings
- AI-assisted coding with Claude Code and PyCharm (new for 2026)
- PyCharm integration and automated workflows
- Research data publishing with GitHub-Zenodo
**Target audience**: Researchers and graduate students wanting comprehensive software development skills
### Crash Courses (Condensed Formats)
**[Crash-course on version control, clean code and documentation](crash-course/README.md)** in [`clean-code/crash-course`](https://github.com/RISE-UNIBAS/clean-code/tree/main/crash-course)
Condensed version covering core topics in 3-6 hours.
**[Crash-course on version control and documentation with GitHub](crash-course-github/README.md)** in [`clean-code/crash-course-github`](https://github.com/RISE-UNIBAS/clean-code/tree/main/crash-course-github)
Focused crash course on GitHub workflows and documentation.
## License
This work is licensed under a Creative Commons Attribution 4.0 International License.