WayfireWM / WayfireWM/wayfire

Add a helper to access config.h from public API headers

Open
#2,973 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

codebase easy good first issue
Dominant language
C++
Stars
3.1k
Forks
237
Avg merge
1h 43m
Merged PRs (30d)
1

Description

Currently, to include config.h in the public API headers, we need a check whether we are in Wayfire's own repo (where the path to the file is simply config.h), or whether we are being used from an external plugin, where we need to use wayfire/config.h instead. Since this is duplicated in multiple headers, it would probably make sense to add a common header file which can work in both cases, and contains the check.

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.

Research direction

Inspect the public API headers that duplicate the config.h path check and review how config.h is included inside Wayfire and by external plugins. Add a common header that handles both include paths, then verify that both repository and external-plugin use cases resolve config.h correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
api
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.