Skip to content

guidelines: code: Update information of modern practices and dependencies #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
patrickelectric wants to merge 1 commit into
base: master
Choose a base branch
from
+10 −3
Open

guidelines: code: Update information of modern practices and dependencies #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions guidelines/code.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,12 +118,19 @@ Code should be developed with a high level of abstraction and with portability i
- For embedded applications, multiple (if not any and all) targets should be considered (eg. SBCs for companion, uCs for sensor drivers)
- Use a transparent build system to expose all dependencies and requirements to build a project. Don't rely on eclipse to generate your makefiles; avoid closed vendor tools and compilers like `arm-attolic-eabi-gcc`. Anyone should be able to clone one of our projects and build it with readily available opensource toolchains.

## Dependencies

- Pin all dependencies to exact versions in dependency files (`package.json`, `requirements.txt`, `Cargo.toml`, etc.)
- Keep dependencies, toolchains, and compilers up to date with the latest stable releases

## Modern Best Practices

Take time maintain your education on modern best practices for your software projects.
Take time to maintain your education on modern best practices for your software projects.

- Use at least c++11 or newer standard for c projects
- Use python3 for python projects
- Use C++14 or newer standard for C++ projects
- Use Python 3.11+ for Python projects
- Use Rust for new systems programming and backend services
- Use TypeScript for web applications
- Generally keep our projects, dependencies, toolchains, and compilers up to date with the latest stable releases

## What should be avoided
Expand Down