Adapt structure of project proposals and questionnaires

* Move questionnaire and project proposals to folders per stage * Add stage 2 questionnaire * Add stub for stage 3 questionnaire * Use hyphens instead of underscores in filenames everywhere Signed-off-by: Cornelius Schumacher <[email protected]>
OpenRailAssociation · Oct 9, 2024 · 8a98474 · 8a98474
1 parent d5436d2
commit 8a98474
Show file tree

Hide file tree

Showing 17 changed files with 79 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@ The Technical Committee meets once per week. The agenda for each meeting is prep
 
 ## Projects
 
-Projects can join the OpenRail Association by using the [incubation process](incubation_process.md). Projects are supposed to adhere to certain standards to foster high quality projects which are useful to the sector. The barrier of entry is meant to be low, though. We want to provide an environment where projects can grow within the OpenRail Association.
+Projects can join the OpenRail Association by using the [incubation process](incubation-process.md). Projects are supposed to adhere to certain standards to foster high quality projects which are useful to the sector. The barrier of entry is meant to be low, though. We want to provide an environment where projects can grow within the OpenRail Association.
 
 We maintain a set of [project templates](project-templates/) which provides a baseline for projects joining the OpenRail Association in terms of governance according to open principles.
 

diff --git a/incubation_process.md → incubation-process.md b/incubation_process.md → incubation-process.md
diff --git a/meetings/2024-06-04.md b/meetings/2024-06-04.md
@@ -9,7 +9,7 @@ Present: Cornelius, Peter, Loic, Stephanie, Florian; Excused: Frederik; Guest: M
 * Management of GitHub organization (https://github.com/OpenRailAssociation/technical-committee/blob/main/project-handbook/github-management.md)
 * Preparation of TC report for board meeting
 * NGE proposal (https://github.com/OpenRailAssociation/technical-committee/pull/68)
-* Criteria for incubation stages 2 and 3 (https://github.com/OpenRailAssociation/technical-committee/blob/main/incubation_process.md)
+* Criteria for incubation stages 2 and 3 (https://github.com/OpenRailAssociation/technical-committee/blob/main/incubation-process.md)
 
 ## Protocol
 
@@ -24,4 +24,4 @@ Present: Cornelius, Peter, Loic, Stephanie, Florian; Excused: Frederik; Guest: M
   * Scope of the TC is candidates (started the questionnaire) and members (already accepted)
 * NGE proposal. We discussed some questions, Peter will update the questionnaire together with the NGE people. We will continue the review asynchronously on GitHub. There already is collaboration with OSRD going on. This is very positive which should ideally already be reflected in the questionnaire.
 * SBB is working with a sponsor to provide a demo version of NGE. Might be useful for future OpenRail projects as well.
-* Main topic for next week: Discuss criteria for projects to move to stage 2 of the incubation process (see https://github.com/OpenRailAssociation/technical-committee/blob/main/incubation_process.md#stage-2-incubation)
+* Main topic for next week: Discuss criteria for projects to move to stage 2 of the incubation process (see https://github.com/OpenRailAssociation/technical-committee/blob/main/incubation-process.md#stage-2-incubation)
diff --git a/meetings/2024-06-11.md b/meetings/2024-06-11.md
@@ -1,12 +1,12 @@
 # TC Meeting 2024-06-04
 
-Present: Cornelius, Peter, Stephanie, Max; Excused: Loic, Florian, Frederik 
+Present: Cornelius, Peter, Stephanie, Max; Excused: Loic, Florian, Frederik
 
 ## Agenda
 
 * New project proposal: NGE (https://github.com/OpenRailAssociation/technical-committee/pull/68)
 * Onboarding of RCM OSS (moving repositories)
-* Discuss criteria for projects to move to stage 2 of the incubation process (see https://github.com/OpenRailAssociation/technical-committee/blob/main/incubation_process.md#stage-2-incubation)
+* Discuss criteria for projects to move to stage 2 of the incubation process (see https://github.com/OpenRailAssociation/technical-committee/blob/main/incubation-process.md#stage-2-incubation)
 * GitHub management (people and teams)
 
 ## Protocol

diff --git a/project-handbook/dco.md b/project-handbook/dco.md
@@ -6,7 +6,7 @@ This means that with each commit the author of the commit includes a statement w
 
     Signed-Off-By: Jane Doe <[email protected]>
 
-For projects on stage 2 and 3 of the [incubation process](https://github.com/OpenRailAssociation/technical-committee/blob/main/incubation_process.md), the DCO is required. Projects on stage 1 can choose to require it as well. Projects which require the DCO have the [DCO App](https://github.com/apps/dco) enabled, which checks pull requests for the DCO statements and throws an error if they are missing.
+For projects on stage 2 and 3 of the [incubation process](https://github.com/OpenRailAssociation/technical-committee/blob/main/incubation-process.md), the DCO is required. Projects on stage 1 can choose to require it as well. Projects which require the DCO have the [DCO App](https://github.com/apps/dco) enabled, which checks pull requests for the DCO statements and throws an error if they are missing.
 
 > [!NOTE]
 > If you are using [merge queue](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue#about-merge-queues), you should not use [DCO App](https://github.com/apps/dco). Because of [a bug](https://github.com/dcoapp/app/issues/199) the bot doesn't run in a merge queue.

diff --git a/project-proposals/README.md b/project-proposals/README.md
@@ -0,0 +1,5 @@
+This directory contains the questionnaires and project proposals on the different stages of the incubation process. To apply for entering a project into the next stage of the process, copy the questionnaire to your own file, fill it out and submit it as a pull request.
+
+* [Stage 1 Questionnaire -- New Projects](stage-1/stage-1-questionnaire.md)
+* [Stage 2 Questionnaire -- Mature Projects](stage-2/stage-2-questionnaire.md)
+* [Stage 3 Questionnaire -- Officially Recommended Reference Projects](stage-3-stage-3-questionnaire.md)
diff --git a/project_proposals/NGE.md → project-proposals/stage-1/NGE.md b/project_proposals/NGE.md → project-proposals/stage-1/NGE.md
diff --git a/project_proposals/RCM OSS.md → project-proposals/stage-1/RCM OSS.md b/project_proposals/RCM OSS.md → project-proposals/stage-1/RCM OSS.md
diff --git a/...t_proposals/dac-migration-dss-roadmap.png → ...als/stage-1/dac-migration-dss-roadmap.png b/...t_proposals/dac-migration-dss-roadmap.png → ...als/stage-1/dac-migration-dss-roadmap.png
diff --git a/project_proposals/dac-migration-dss.md → ...ct-proposals/stage-1/dac-migration-dss.md b/project_proposals/dac-migration-dss.md → ...ct-proposals/stage-1/dac-migration-dss.md
diff --git a/project_proposals/liblrs.md → project-proposals/stage-1/liblrs.md b/project_proposals/liblrs.md → project-proposals/stage-1/liblrs.md
diff --git a/project_proposals/osrd.md → project-proposals/stage-1/osrd.md b/project_proposals/osrd.md → project-proposals/stage-1/osrd.md
diff --git a/new-project-questionnaire.md → ...roposals/stage-1/stage-1-questionnaire.md b/new-project-questionnaire.md → ...roposals/stage-1/stage-1-questionnaire.md
@@ -1,6 +1,6 @@
 # Questionnaire for projects intending to join the OpenRail Association
 
-*As a project intending to join the OpenRail Association, please fill out this questionnaire and send it to the Technical Committee. See the [incubation process](incubation_process.md) for details about criteria and requirements for new projects and how it works to get new projects into the association.*
+*As a project intending to join the OpenRail Association, please fill out this questionnaire and send it to the Technical Committee. See the [incubation process](../../incubation-process.md) for details about criteria and requirements for new projects and how it works to get new projects into the association.*
 
 *Copy this template and fill in your answers to the questions in the sections below.*
 

diff --git a/project-proposals/stage-2/stage-2-questionnaire.md b/project-proposals/stage-2/stage-2-questionnaire.md
@@ -0,0 +1,60 @@
+# Stage 2: Incubation
+
+*As a project intending to move to stage 2 of the OpenRail incubation process, please fill out this questionnaire and send it to the Technical Committee. See the [incubation process](../../incubation-process.md) for details about criteria and requirements for new projects and how it works to get new projects into the association.*
+
+*Copy this template and fill in your answers to the questions in the sections below.*
+
+## Health metrics
+
+*How to assess project health depends on the context of the concrete project. Please answer the questions below and add any additional explanations or data you see as useful to show that the project has a healthy community and development activity.*
+
+### How many committers does the project have?
+
+
+### How many different organizations are contributing to the project?
+
+
+### How much is the project dependent on individual contributors?
+
+*How high is the risk to a project should the most active people leave? This is called the [Contributor Absence Factor](https://chaoss.community/kb/metric-contributor-absence-factor/), sometimes also referred to as bus factor.*
+
+
+### How active is the project?
+
+*Indicate activity by number of commits, number of issues closed, pull request merged, etc.*
+
+
+## Open governance
+
+### What is the release process of the project?
+
+*Indicate documentation of the release process, how changes are communicated, versioning schemes, signing of release artifacts, etc.*
+
+
+### How are decisions taken in the project?
+
+*Indicate documentation of the project governance.*
+
+
+### What is the business roadmap of the project?
+
+*Indicate links to the roadmap of the project and how planning is done.*
+
+
+## Adoption
+
+### Where is the project used in production?
+
+
+### If the project includes specifications, where are reference implementations for these specifications?
+
+
+## Licensing
+
+### Is the project REUSE compliant?
+
+*Does the project include licensing information according to the [REUSE standard](https://reuse.software)? When is the REUSE linter run? Does the project show a REUSE badge?*
+
+### Does the project use the Developer Certificate of Origin?
+
+*Do commits include "Signed-Off" trailers? Is the DCO bot enabled on the project?*
diff --git a/project-proposals/stage-3/stage-3-questionnaire.md b/project-proposals/stage-3/stage-3-questionnaire.md
@@ -0,0 +1 @@
+*to be done*
diff --git a/project_governance.md b/project_governance.md
diff --git a/projects.md b/projects.md
@@ -1,22 +1,22 @@
 # OpenRail Association Projects
 
-This is the list of projects accepted as OpenRail Association projects. Projects acceptance follows the [incubation process](incubation_process.md).
+This is the list of projects accepted as OpenRail Association projects. Projects acceptance follows the [incubation process](incubation-process.md).
 
 ## Stage 1
 
-* Open Source Railway Designer (OSRD) ([proposal](https://github.com/OpenRailAssociation/technical-committee/blob/main/project_proposals/osrd.md)), accepted by vote of the board on 2024-02-02
+* Open Source Railway Designer (OSRD) ([proposal](https://github.com/OpenRailAssociation/technical-committee/blob/main/project-proposals/stage-1/osrd.md)), accepted by vote of the board on 2024-02-02
   * https://github.com/OpenRailAssociation/osrd
   * https://github.com/OpenRailAssociation/osrd-ui
   * https://github.com/OpenRailAssociation/osrd-design
   * https://github.com/OpenRailAssociation/osrd-website
   * https://github.com/OpenRailAssociation/osrd-chart
   * https://github.com/OpenRailAssociation/osrd-images
-* RCM OSS ([proposal](https://github.com/OpenRailAssociation/technical-committee/blob/main/project_proposals/RCM%20OSS.md)), accepted by vote of the board on 2024-03-14
+* RCM OSS ([proposal](https://github.com/OpenRailAssociation/technical-committee/blob/main/project-proposals/stage-1/RCM%20OSS.md)), accepted by vote of the board on 2024-03-14
   * https://github.com/OpenRailAssociation/rcm-dx
-* DAC Migration DSS ([proposal](https://github.com/OpenRailAssociation/technical-committee/blob/main/project_proposals/dac-migration-dss.md)), accepted by vote of the board on 2024-04-15
+* DAC Migration DSS ([proposal](https://github.com/OpenRailAssociation/technical-committee/blob/main/project-proposals/stage-1/dac-migration-dss.md)), accepted by vote of the board on 2024-04-15
   * https://github.com/OpenRailAssociation/dac-migration-dss
-* Netzgrafik-Editor ([proposal](https://github.com/OpenRailAssociation/technical-committee/blob/main/project_proposals/NGE.md)), accepted by vote of the board on 2024-06-21
-* liblrs ([proposal](https://github.com/OpenRailAssociation/technical-committee/blob/main/project_proposals/liblrs.md)), accepted by vote of the board on 2024-07-12
+* Netzgrafik-Editor ([proposal](https://github.com/OpenRailAssociation/technical-committee/blob/main/project-proposals/stage-1/NGE.md)), accepted by vote of the board on 2024-06-21
+* liblrs ([proposal](https://github.com/OpenRailAssociation/technical-committee/blob/main/project-proposals/stage-1/liblrs.md)), accepted by vote of the board on 2024-07-12
 
 ## Administrative Projects