OpenRailAssociation / technical-committee

Landing place for all things related to the Technical Committee of the OpenRail Association
Creative Commons Attribution 4.0 International
4 stars 6 forks source link

Create questionnaire and repo structure for projects applying for stage 2 of the incubation process #145

Open cornelius opened 1 month ago

cornelius commented 1 month ago

We are in the process of defining the criteria for stage 2 of the incubation process (#78) and are doing that with the concrete example of OSRD as the first applicant (#141). From this we identified a few improvements:

cornelius commented 1 month ago

Proposed directory structure:

project-proposals
├--- README.md
├--- stage-1
│   ├---osrd.md
│   ├--- rcm-oss.md
│   ├--- nge.md
│   ├--- dac-migration-dss.md
│   └--- liblrs.md
├--- stage-1-questionnaire.md
├--- stage-2
│   └--- osrd.md
├--- stage-2-questionnaire.md
├--- stage-3
│   └--- ...
└--- stage-3-questionnaire.md
cornelius commented 1 month ago

And I would keep the file https://github.com/OpenRailAssociation/technical-committee/blob/main/new-project-questionnaire.md, but change its content to point to the new questionnaire files. We have linked this file in various places and it has worked well as entry point for new projects already, so keeping this prominent in the root directory is probably a good idea.

mxmehl commented 1 month ago

Thanks for the proposal. Here are my two cents:

Unify the usage of hyphens/underscores in the file and directory names (I would suggest to always use hyphens, that's the convention we already use for most files)

+1 to that!

And I would keep the file main/new-project-questionnaire.md, but change its content to point to the new questionnaire files. We have linked this file in various places and it has worked well as entry point for new projects already, so keeping this prominent in the root directory is probably a good idea.

Hm, I'm not sure whether the issue of moving/deleting that file would cause that many problems. Where did you spread this file, and won't interested people be able find the location themselves?

In the long run, such content would probably also be located on a website which includes a search function.

cornelius commented 1 month ago

Hm, I'm not sure whether the issue of moving/deleting that file would cause that many problems. Where did you spread this file, and won't interested people be able find the location themselves?

We shared it in emails and chats, but that of course will be less relevant over time. So maybe we just keep it as a stub for now and remove it later.

In the long run, such content would probably also be located on a website which includes a search function.

A page on the web site "How to join as a project?" as a permanent entry point containing or linking to all the relevant information sounds like a great idea.