rest-for-physics / rest-for-physics/framework

Move project folder structure to a more comprehensive way

Open
#152 13 comments 0 reactions 0 assignees View on GitHub

@jgalan is already working on this.

Since Mar 15, 2022.

  • #153 by @jgalan — open
Dominant language
C++
Stars
19
Forks
14
PR merge metrics
No merged PRs in 30d

Description

While I was creating AlphaCAMM project I found that the projects in the repository https://github.com/rest-for-physics/framework/tree/master/projects are split in different subfolders (projects) that doesn't follow a comprehensive structure, e.g. for IAXO we have:
iaxo-analysis
iaxo-simulations
iaxo-geometry
iaxo-readouts

I would suggest to create a folder (project) named iaxo and create inside the different sub-folders: analysis, simulations, geometry and readouts. I am working in a project for alphaCAMM that we can use as template or at least we can iterate over it.

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 inspecting the projects/ directory and the existing IAXO folders, then read linked pull request #153 for the proposed direction and AlphaCAMM template. Confirm which project folders are in scope and whether repository references need updates. Done means projects use the agreed parent-project/subproject structure without breaking existing references.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.