Skip to content
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.

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

Cleanup includes #240

Open
jr1221 opened this issue Dec 5, 2024 · 0 comments
Open

Cleanup includes #240

jr1221 opened this issue Dec 5, 2024 · 0 comments
Assignees

Comments

@jr1221
Copy link
Contributor

jr1221 commented Dec 5, 2024

Description

Right now, header imports are a friggin mess. Clean that stuff up.

Acceptance Criteria

Follow these header guidelines:

  • All things imported should be directly used in the same file
  • Import something into a .c file if you use the API but import to the .h file if you depend on public types
  • Use <> includes only for standard libraries (std* stuff); use "" for CubeMX dependencies, embedded-base, and our code isndie the project

Proposed Solution

Follow the acceptance criteria, and also it may just be easiest to remove each header until shit breaks. Make sure you arent employing transitive dependencies such that one file includes another file that includes the actual dependency. So if you remove a import from file A and file B breaks, then file B needs the import not file A.

@rubennoro rubennoro self-assigned this Dec 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants