mapbox / mapbox/cpp

Documentation on when/why/how to write `_impl.hpp`

Open
#12 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
110
Forks
17
PR merge metrics
No merged PRs in 30d

Description

@tmpsantos thanks for working on https://github.com/mapbox/geojson-cpp/pull/24. Now I'd like your help in documenting your work so others can do this again for further projects. Can you write up a quick guide on how you accomplished this, key terms, and why you chose `_impl.hpp` as an extention (let's standardize on that). Drop your notes into this ticket as a comment please and then we'll integrate into the main readme.

/cc @mapsam @GretaCB

refs https://github.com/mapbox/hpp-skel/issues/3

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

Start by reading the work in pull request #24 and the referenced hpp-skel issue #3. Write a short guide covering how the work was done, key terms, and why `_impl.hpp` should be standardized, then add the notes as a comment and integrate them into the main README.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.