Source tree clean-up / reorganize
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 13.6k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
It was brought up recently in a mail discussion that our source tree is "disorganized" with like "800 source files in a single directory". This is absolutely true. I'm so used to it I haven't cared much about it. Making it better should be pretty easy. Here are two easy steps for making it a little better:
- For a starter, we could move all plugins (and nothing else) to
src/plugins. That will half the number of files directly undersrc... - We have lots of pure OpenCL headers (for inclusion by kernels) directly under
src, they should either go tosrc/opencllike the kernels - or perhapssrc/opencl/includeif we want to.
After that, it gets trickier to get lots of improvement with little work but we can probably find out a couple more things.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inventorying the files directly under src and identifying the plugins and pure OpenCL headers mentioned in the issue. Move plugins to src/plugins and place the OpenCL headers under src/opencl or src/opencl/include; done means the source tree is reorganized without breaking the project.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100