-
Notifications
You must be signed in to change notification settings - Fork 0
Home
These guidelines are aimed to cover as detailed as possible every aspects of development and operations within Teku organization.
Some of them can be considered good, but not best practices, just simply our taste of doing things, in the Teku's way
to make healthy products, relecting Teku visions and ideologies.
We prefer concise over simple. The solutions should be effective to solve its very own problems at the same time not carrying risky or unnecessary impacts on targeted products.
The solutions should be easy to setup, applied and integrated to targeted products.
A good code base should be cross-platform, minimized the gaps / differences between operation systems within the development team or product environments.
A good code should also selectively following good standards and be "clean" (easy to read and maintain) to a average of the development team as well.
For that we often get started with some popular tools:
-
.editorconfig
,.gitattributes
- Docker (https://docs.docker.com/get-docker/) to containerize and share setup among development team, between local and other product environments
- Code standards (For example
standard
,eslint
for JS, PSR for PHP...) - Structure standards:
- For example
monorepo
to setup codebase - Selectively pick some rules from https://jsonapi.org/, https://developers.google.com/search-ads/v2/standard-error-responses for hypermedia API systems
- MVC, gRPC ... and a wide range of other boilerplates in the wild
- For example
A good code base should also be documented on how to setup, quick start guides for the next developers.