https://github.com/carpentries-incubator/byte-sized-rse-code-quality
Byte-Sized RSE: Code Style, Quality & Linting
https://github.com/carpentries-incubator/byte-sized-rse-code-quality
alpha byte-sized-rse carpentries-incubator code-linting code-quality code-style english lesson
Last synced: 2 months ago
JSON representation
Byte-Sized RSE: Code Style, Quality & Linting
- Host: GitHub
- URL: https://github.com/carpentries-incubator/byte-sized-rse-code-quality
- Owner: carpentries-incubator
- License: other
- Created: 2025-10-23T12:11:14.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-12-16T01:54:28.000Z (3 months ago)
- Last Synced: 2025-12-19T12:19:15.181Z (3 months ago)
- Topics: alpha, byte-sized-rse, carpentries-incubator, code-linting, code-quality, code-style, english, lesson
- Language: Dockerfile
- Homepage: https://carpentries-incubator.github.io/byte-sized-rse-code-quality/
- Size: 7.25 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
## Byte-Sized RSE: Code Style, Quality & Linting
This is a Byte-Sized RSE lesson on code style, quality & linting, part of the [Byte-Sized RSE Series](https://github.com/carpentries-incubator/byte-sized-rse-overview/tree/main).
### Questions
- Why does consistent code style matter in software development?
- What are some common code styling practices and conventions?
- How can poor coding style lead to bugs and maintenance issues?
- What is a linter, and how does it help improve code quality?
### Learning Objectives
At the end of this lesson, learners should be able to:
- Understand why consistent code style is important for collaboration and long-term maintainability.
- Identify key code style practices and how they vary between programming languages.
- Recognise how maintaining good code style can reduce bugs and improve code quality.
- Explain what a linter is and describe its role in detecting errors and enforcing style.
- Perform automated code style checking and static code analysis with Pylint.
### Slides
[Slides](https://docs.google.com/presentation/d/1qNyDV3VDwv6Z3RHwfn5hL0pFxzK_DsWN3bPMjwV7Uoc/edit?usp=sharing) available under CC BY 4.0 licence.
### Recordings
* Recording of the "Code Style, Quality & Linting" session delivered at SSI's RSC7, 12 November 2025