Coding Period - Week 1
The focus of this week was to establish a foundation for coding standards and practices within the JdeRobot community. The goal is to ensure that all code contributions are consistent, maintainable, and adhere to best practices.
Work Done This Week
- Define an initial Coding Style Guide through a survey -> Discussion
- Setup an initial linting CI workflow for Python using Black
- Research other best practices (Branch Protection, pre-commit Hooks, …)
Reflections
- My main focus was:
- Make sure the style guide is easy to follow and implement
- Ensure tooling support (i.e. there are mature linters and formatters available to enforce the style)
- The balance between opinionated style and flexibility for custom configuration
Next Week Plan
- Finish the Coding Style Guide
- Finish IDE setup guide to enforce the Coding Style Guide
- Implement linting CI workflows for all 3 repositories
- Conduct survey about other best practices (Branch Protection, pre-commit Hooks, …)