openPMD/openPMD-api

Namespace Per Dir

Open

#82 opened on Feb 19, 2018

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)C++ (57 forks)auto 404
api: breakinggood first issuehelp wanted

Repository metrics

Stars
 (160 stars)
PR merge metrics
 (PR metrics pending)

Description

Follow-up to #81.

Each directory inside include/openPMD/ should define everything in a namespace with the same name as the dir.

  • backend/ (openPMD::backend)
  • IO/ (openPMD::IO)
    • ADIOS/ (openPMD::IO::ADIOS)
    • HDF5/ (openPMD::IO::HDF5)

Contributor guide

Research direction
Inspect the directory structure under include/openPMD/, then add namespace declarations matching each folder name to all header/source files, and update any code that references these classes/functions to use the new namespaces.
Tech stack
cpp
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75