Toolchain
The toolchain will help you to develop, build, and organize your projects. We should use the same tools and configurations across all projects to ensure consistency and maintainability.
- Visual Studio Code: We use Visual Studio Code as our primary code editor. All projects should have a
.vscode
directory with settings that enforce consistent code style. - Prettier: We use Prettier for code formatting. All projects should have a
.prettierrc
file that defines the code formatting rules. - ESLint: We use ESLint for JavaScript projects. All projects should have an
.eslintrc
file that defines the linting rules. - TypeScript: We use TypeScript for JavaScript projects. All projects should have a
tsconfig.json
file that defines the TypeScript compiler options. - Docker: We use Docker for containerization. All projects should have a
Dockerfile
that defines the project's runtime environment. - Version Control: We use Git for version control. All projects should be stored in a Git repository.
- Branching Strategy: We use the Gitflow branching strategy. Check the Branching Strategy document for more information.
- Code Review: We use GitHub Pull Requests for code review. All code changes should be reviewed by at least one other team member before merging.
- Continuous Integration: We use GitHub Actions for continuous integration. All projects should have a CI pipeline that runs tests and linters on every push.
- Code Quality: We use ESLint for JavaScript/Typescript projects. All projects should have linting rules that enforce code quality.
- Documentation: We use Markdown for documentation. All projects should have a
docs
directory with aREADME.md
file that explains how to set up and run the project.