Repository navigation
Provide (almost empty) template repository for modules #511
Description
Provide template for C++ or Rust modules. (One or seperate template, to be discussed)
Content e.g.:
- toolchain incl formatter, linter, syntax highlighting
- gitlint
- README.md
- LICENSE.md
- CONTRIBUTION.md
- docs with venv
- github actions
- cr_checker
- dash integration
We'll start with an almost empty template repository, and add more tools as they become ready for "reuse" as in #503
Urgent open points:
- Are we talking about "GitHub template repositories" here or some other approach?
- Is it 1 or 2 templates. Do we expect mixed language modules?
Metadata
Metadata
Assignees
Labels
No labels
Type
Projects
- Status
Activity
[-]Provide repository template for modules[/-][+]Provide template repository for modules[/+]AlexanderLanin commentedon Feb 27, 2025
We can create a new one or extend the
examplesrepository... since there is no clear opinion let's extend the examples.Link: https://github.com/eclipse-score/examples
What can we do now? Most of the stuff seems blocked by other issues!
[-]Provide template repository for modules[/-][+]Provide (almost empty) template repository for modules[/+]dcalavrezo-qorix commentedon Mar 6, 2025
First things first, we need to summarize what should be included:
Tools and linters should be integrated from centralized repos.
Based on the repo type ( RUST / C++ ), we should decide on dependency management.
We need to clarify how to handle a centralized docs structure.
The template should contain a basic
helloworldexample ( for both RUST and C++) - with documented source files and it should be buildable out of the box ( including tests, documentation).The set of tools that should be included has to be clarified as well.
dcalavrezo-qorix commentedon Mar 6, 2025
https://github.com/dcalavrezo-qorix/cpp-template-repository
draft created, let's review it, expand it and afterwards I will convert it to an otterdog template
dcalavrezo-qorix commentedon Mar 6, 2025
ok, the template has been updated, both RUST and CPP were added.
Also I have integrated the
cr_checkertool as an external module.Now this has to be integrated in otterdog
dcalavrezo-qorix commentedon Mar 7, 2025
created draft PR
eclipse-score/.eclipsefdn#19
dcalavrezo-qorix commentedon Mar 10, 2025
eclipse-score/module_template#1
dcalavrezo-qorix commentedon Mar 12, 2025
As discussed during our calls, the template repository is an incremental work in progress.
Open points that should be taken in consideration
otterdog, as this hasn't been tested yet. Hence its early creation.So, this is an incremental work in progress. We could theoretically discuss and plan every aspect, but I think it will take too long, or we can actually have a
POC-like approach, which we can adjust later on.AlexanderLanin commentedon Mar 25, 2025
Let's create new tickets for all open points and close this one. Otherwise it's not really clear what is open.
@dcalavrezo-qorix @nicu1989 can you create tickets for everything that is currently missing (and not planned)?