Coding Standards

eBL Coding Standards

General

• Write clean code. Use linters and analysers to find code smells.
• Use up to date technologies. E.g. Python 3 instead of Python 2.
• Use a deterministic package manager. E.g. yarn, poetry, or pipenv.
• Write tests for your code. Test Driven Development is recommended but not mandatory. There is no hard requirement for code coverage but it should improve over time.
• Prefer a single branch workflow. If branches are needed use GitHub Flow.
• Implement a proper domain model. Avoid passing data around in dictionaries.
• Prefer immutable value objects. attrs and Immer make the task easier.
• Update this documentation if an issue which is not covered arises.
• When contributing to projects outside eBL adhere to their standards.

JavaScript

• Use Prettier or JavaScript Standard Style.
• Stick to the good parts.
• Consider using statically typed alternative (e.g. TypeScript), but do not mix the languages in a single project.
• Avoid Common mistakes with React Testing Library.

Python

• Use Black or PEP 8 style.

HTML/CSS

• Try to use semantic HTML.
• Use BEM naming convention.