RoaringBitmap / RoaringBitmap/CRoaring
Cleanup headers
Open
Nobody has claimed this yet.
later
- Dominant language
- C
- Stars
- 1.9k
- Forks
- 334
- Avg merge
- 2d 5h
- Merged PRs (30d)
- 17
Description
I'd give a little love to the headers:
- separate concerns (basic operations, advanced operations, serializations) in multiple headers, such the user can only import what he needs.
- hide definitions, does the user really need the full definition? We could probably hide in a forward declaration à la
struct roaring_bitmap; - Remove unnecessary public that should really be private stuff.
Contributor guide
No contributing guide indexed for this repository
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
No files, tests, or entry points are named. Review the public headers and determine how basic, advanced, and serialization operations could be separated, which definitions can be hidden behind forward declarations, and which public items should become private; done means the proposed header cleanup is implemented without exposing unnecessary definitions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- api, developer-experience
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100