Reorganization proposal

Open
#419 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Refactor
Clarity
Needs clarification
Activity status
Stale
Tech stack
cpp
Domain
build-system

Research direction

Review the repository's existing component folders and their include/ directories, then compare them with the proposed include/datasketches layout and the pybind11 precedent linked in the issue. Before changing files, confirm that maintainers have agreed on a target organization; done would require an accepted layout that provides a single include path for foreign build systems.

Written by the indexing model from the issue text.

Description

Hi there,

We are consider using datasketches in our C++ environment. The current organization, where there a bunch of folders, each with an include/ directory, is a bit awkward for integrating into a foreign build system. Projects like pybind11 put all of the headers in a single include/ directory (perhaps with subdirectories underneath). Then there is just a single path to add as an include path.

Would you be open to a reorganization that moved around files to look a bit like this:

include/datasketches
  count/
    count_min.hpp
    count_min_impl.hpp
  common/
    MurmurHash3.h
    ...

Thanks for your consideration.

Dominant language
C++
Stars
273
Forks
88
Avg merge
1d 19h
Merged PRs (30d)
9

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 apache/datasketches-cpp

All issues in apache/datasketches-cpp

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.