How do you document code style in open source
- Choose a standard or a custom style
It’s generally better to follow existing standards rather than creating a custom style. Tools like pylint and ESLint can be integrated into your push pipelines to ensure code submissions adhere to a specific standard.
Consider this: users spend only a brief time on your WebApp/App, so they shouldn’t have to learn a new standard. The same applies to open source standards.
- Document your style guide