search

software-engineering-project-org / vscode-plugin-automotive-app-deployment

Code base for LAD (Leda App Deployer) - a Visual Studio Code Plugin simplifying deployment of Velocitas Apps on Leda-running devices
Apache License 2.0
2 stars 1 forks source link

Setup Code Guidelines mandatory for Eclipse Contribution #111

Closed dangelic closed 1 year ago

dangelic commented 1 year ago

See: https://github.com/eclipse-velocitas/vehicle-app-cpp-sdk/blob/main/CONTRIBUTING.md

--> This file is for C++ projects. However, we might need to use this as a compass for our final improvements before contribution.

TODO: Find alternatives for the C++ tools OR find a document from Eclipse with generic guidelines or guidelines for JS-Projects.

In the C++ Guideline, the following points are stated, which we need to take into account:

1. Install pre-commits: https://pre-commit.com/ --> This works for every language. We already have husky here but we might refactor this if we have to use the dedicated pre-commit tool. Also, we need to specify pre-commits, by now, we only habe npm run format for style. 2. Auto-Code-Improvements: Find an alternative for clang-tidy! 3. Linting: We already used Sonar-Lint (once). We've already erased code-smells. We might consider TSLint here. 4. Checking: We might need a checker for code insecurities and problems. Find an alternative for cppcheck! 5. Formatting: We already have prettier. Are there any styling guidelines (indentation, semicolons, ...)?

cpotter302 commented 1 year ago

File husky.sh is missing in git