README.md

Tools and Linters

Getting the most out of an automatic toolchain in order to focus on the best part of our work.

Documentation

First thing first, each good project must have good internal ressources. Installation, team, guidelines, environments, features…

./README.md

The main entry point, everything start here.
A global dedicated folder is encouraged (eg. ./docs)

Example:

<!-- ./README.md -->
# App name

Few words of introduction… app purpose… key features…

1. [Installation](./docs/install.md)
1. [Git guidelines](./docs/git.md)
1. [Feature A](./…/feature-a/README.md)

Alternatively, for main features, a README.md on the dedicated folder can be an option.

💡 Tips

1. It is recommended to use an helper such as markdownlint or equivalent in order to lint and improve consistency and readability.

📚 Ressources

1. Outdated Docs Are Tech Debt

Git & cie

👀 Take a look at the dedicated Git recommandations.

CI/CD

1. .gitlab-ci.yml
2. .gitlab/
   • A good way to organize templates (eg. MR templates and so on).
3. Danger (Js)
   1. Config
   2. eg. dangerfile.common.ts

Node & cie

Versions

Our App itself SHOULD track current Node and Npm (|| Yarn) used version. Distinct versions on a team can at least generate config conflicts.

1. .nvmrc
2. .npmrc

Keep up with releases

1. Renovate (|| Dependabot)
   1. renovate.json
2. Semantic release (|| Release it)

IDE

1. .vscode/
   • eg. .vscode/{settings | extensions | launch…}.json

Linters & cie

1. Editorconfig
2. Prettier
   1. Config
   2. Ignore
3. ESLint
   1. Config
   2. Ignore
   3. ⚠️ No more [deprecated] TSLint
4. Stylelint
   1. Config
   2. Ignore

Monitoring

1. 📗 Vitality
2. SonarQube
3. Sentry
4. Snyk