cpp: audit include statements

Open
#102 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Stale
Tech stack
cpp
Domain
ci-cd, tooling

Research direction

Start by reviewing include warnings in the C++ code across LizardByte/Sunshine, LizardByte/libdisplaydevice, and LizardByte/tray. Compare cppclean and include-what-you-use against the CLion findings, then determine the CI scope. Done means the includes have been audited and an agreed automated check is integrated into CI.

Written by the indexing model from the issue text.

Description

1-3 months C++ effort:Large LizardByte/libdisplaydevice LizardByte/Sunshine LizardByte/tray planned priority:High
Is there an existing issue for this item?
  • I have searched the existing issues
Repositories

LizardByte/Sunshine, LizardByte/libdisplaydevice, LizardByte/tray

Languages/Skills/Technologies

C++

Description

Many includes are shown as not used by CLion. I haven't investigated if these are legitimate warnings, but we should audit the includes and probably automate it as part of CI.

I found the following that might be able to help:

https://stackoverflow.com/questions/614794/detecting-superfluous-includes-in-c-c

Estimated Effort

effort:Large

Priority

priority:High

Target Milestone

1-3 months

Dependencies

No response

Dominant language
No language data
Stars
2
Forks
0
Avg merge
25m
Merged PRs (30d)
5

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from LizardByte/roadmap

All issues in LizardByte/roadmap

Similar issues

More DevOps issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.