|
|
As CAB-Admin you are responsible for the administration of the CAB itself and the assessment framework for the projects. Besides that it is up to you to take care of our community and keep them in a good mood :)
|
|
# Scope
|
|
|
|
|
This guide describes the administration process for hosting project assessments in the OSEGeV Conformity Assessment Body.
|
|
|
First of all: A big thank you for your support in our assessment project. We are depending on people like you to get this amazing vision running, so we are really happy to have you with us!
|
|
|
|
|
|
|
|
|
|
In this guide we will introduce you to the main tasks you will be able to perform:
|
|
----
|
|
|
- [Community Issues](#community-issues)
|
|
|
|
|
- [Adding a new project](#adding-projects)
|
|
in rework
|
|
|
- [Adding new project members](#adding-members)
|
|
|
|
|
- [Assessment](#assessment)
|
|
---
|
|
|
|
|
|
|
|
Only need a reminder? Then you might want to jump directly to the [Quick Check](#quick-check) at the end.
|
|
As CAB-Admin you are responsible for the administration of the CAB itself and the assessment framework for the projects. Besides that it is up to you to take care of our community and keep them in a good mood :)
|
|
|
|
|
|
|
|
## Community Issues
|
|
First of all: A big thank you for your support in our assessment project. We are depending on people like you to get this amazing vision running, so we are really happy to have you with us!
|
|
|
First of all let's start with our most valuable concern, our community. As CAB-Admin you will be one of the contact persons regarding everything around the workflow of the CAB. The workflow depends on the community and the community depends on some caretaking.
|
|
|
|
|
|
|
In this guide we will introduce you to the main tasks you will be able to perform:
|
|
|
Our community consists of project-developers (applicants for the review), reviewers (proofreading the documentation during the assessment), CAB-developers (working on the workflow development) and lots more.
|
|
- [Community Issues](#community-issues)
|
|
|
|
|
- [Adding a new project](#adding-projects)
|
|
|
### Onboarding
|
|
- [Adding new project members](#adding-members)
|
|
|
The Onboarding makes sure that new members are welcomed and where to find relevant information and how to contribute. There are several possibilities to perform the onboarding:
|
|
- [Assessment](#assessment)
|
|
|
- 1:1 introduction
|
|
|
|
|
- Small events (for specific groups)
|
|
Only need a reminder? Then you might want to jump directly to the [Quick Check](#quick-check) at the end.
|
|
|
- Global events (e.g. during project phases)
|
|
|
|
|
|
|
## Community Issues
|
|
|
## Adding projects
|
|
First of all let's start with our most valuable concern, our community. As CAB-Admin you will be one of the contact persons regarding everything around the workflow of the CAB. The workflow depends on the community and the community depends on some caretaking.
|
|
|
The workflow starts with adding new projects for the review. You will start this process by cloning the project into our repository as described below.
|
|
|
|
|
|
|
Our community consists of project-developers (applicants for the review), reviewers (proofreading the documentation during the assessment), CAB-developers (working on the workflow development) and lots more.
|
|
|
First of all the [requirements for application](/2-Guides/application-guide) have to be checked. If everything is fullfilled the project can directly step in the review stage. Note that as CAB admin you only have to check whether the required items are provided, the investigation of the content is then item of the review process. If there are still open questions the project can be added as development project, helping the applicants to get everything ready for review.
|
|
|
|
|
|
|
### Onboarding
|
|
|
### Overview
|
|
The Onboarding makes sure that new members are welcomed and where to find relevant information and how to contribute. There are several possibilities to perform the onboarding:
|
|
|
Start by adding the project to the [Assessment overview](https://gitlab.opensourceecology.de/verein/projekte/cab/CAB/-/blob/main/archive/assessments.md) and set the status to "development" or "in progress" accordingly (see above). This will show everyone the projects that are or have been undergoing the assessment by OSEGeV.
|
|
- 1:1 introduction
|
|
|
|
|
- Small events (for specific groups)
|
|
|
Next create an Issue in the [Project Assessment Milestone](https://gitlab.opensourceecology.de/verein/projekte/cab/CAB/-/milestones/3) named [Assessment][projectname]. This way our community will have an overview of the projects that are currently perparing for or undergoing assessment.
|
|
- Global events (e.g. during project phases)
|
|
|
|
|
|
|
|
If the project is still under development and needs some work until it can be reviewed it should in any case be put to the list (see above).
|
|
## Adding projects
|
|
|
|
|
The workflow starts with adding new projects for the review. You will start this process by cloning the project into our repository as described below.
|
|
|
Now let's get the project ready:
|
|
|
|
|
|
|
First of all the [requirements for application](/2-Guides/application-guide) have to be checked. If everything is fullfilled the project can directly step in the review stage. Note that as CAB admin you only have to check whether the required items are provided, the investigation of the content is then item of the review process. If there are still open questions the project can be added as development project, helping the applicants to get everything ready for review.
|
|
|
### Upload project
|
|
|
|
|
The projects for reviewing will be uploaded into the [CAB Group](https://gitlab.opensourceecology.de/verein/projekte/cab).
|
|
### Overview
|
|
|
Make sure you know where the Project stores its files and get a copy of it.
|
|
Start by adding the project to the [Assessment overview](https://gitlab.opensourceecology.de/verein/projekte/cab/CAB/-/blob/main/archive/assessments.md) and set the status to "development" or "in progress" accordingly (see above). This will show everyone the projects that are or have been undergoing the assessment by OSEGeV.
|
|
|
In the simpliest case the project is already uploaded on https://gitlab.opensourceecology.de. This way you can just fork the project into the CAB Group. If not you have to create a local git repository and upload it to our
|
|
|
|
|
|
|
Next create an Issue in the [Project Assessment Milestone](https://gitlab.opensourceecology.de/verein/projekte/cab/CAB/-/milestones/3) named [Assessment][projectname]. This way our community will have an overview of the projects that are currently perparing for or undergoing assessment.
|
|
|
**Git Projects**
|
|
|
|
|
- Save the project locally using `git clone [..]` (e.g. `git clone https://gitlab.com/OSEGermany/ohloom`)
|
|
If the project is still under development and needs some work until it can be reviewed it should in any case be put to the list (see above).
|
|
|
**Non-git projects**
|
|
|
|
|
- Download files and put them in a folder
|
|
Now let's get the project ready:
|
|
|
- Make a git repo out of it `git init`
|
|
|
|
|
**Create Repository**
|
|
### Upload project
|
|
|
- Create a repository (without readme) under https://gitlab.opensourceecology.de/verein/projekte/cab
|
|
The projects for reviewing will be uploaded into the [CAB Group](https://gitlab.opensourceecology.de/verein/projekte/cab).
|
|
|
- Name the project like in original, adding the version number (e.g. Open Hardware Loom v1.0)
|
|
Make sure you know where the Project stores its files and get a copy of it.
|
|
|
- Fill the remote repository by changing the upload origin of the local repository
|
|
In the simpliest case the project is already uploaded on https://gitlab.opensourceecology.de. This way you can just fork the project into the CAB Group. If not you have to create a local git repository and upload it to our
|
|
|
|
|
|
|
|
**Push an existing folder**
|
|
**Git Projects**
|
|
|
```
|
|
- Save the project locally using `git clone [..]` (e.g. `git clone https://gitlab.com/OSEGermany/ohloom`)
|
|
|
cd existing_folder
|
|
**Non-git projects**
|
|
|
git init
|
|
- Download files and put them in a folder
|
|
|
git remote add origin ssh://git@gitlab.opensourceecology.de:2222/verein/projekte/cab/ohloom.git
|
|
- Make a git repo out of it `git init`
|
|
|
git add .
|
|
**Create Repository**
|
|
|
git commit -m "Initial commit"
|
|
- Create a repository (without readme) under https://gitlab.opensourceecology.de/verein/projekte/cab
|
|
|
git push -u origin main
|
|
- Name the project like in original, adding the version number (e.g. Open Hardware Loom v1.0)
|
|
|
```
|
|
- Fill the remote repository by changing the upload origin of the local repository
|
|
|
**Push an existing git repository**
|
|
|
|
|
```
|
|
**Push an existing folder**
|
|
|
cd existing_repo
|
|
```
|
|
|
git remote rename origin old-origin
|
|
cd existing_folder
|
|
|
git remote add origin ssh://git@gitlab.opensourceecology.de:2222/verein/projekte/cab/ohloom.git
|
|
git init
|
|
|
git push -u origin --all
|
|
git remote add origin ssh://git@gitlab.opensourceecology.de:2222/verein/projekte/cab/ohloom.git
|
|
|
git push -u origin --tags
|
|
git add .
|
|
|
```
|
|
git commit -m "Initial commit"
|
|
|
#### Assessment Header
|
|
git push -u origin main
|
|
|
Add and fill the [assessment header](https://gitlab.opensourceecology.de/verein/projekte/cab/CAB/-/blob/main/Templates/assessment-header.md) (in Folder [Templates](https://gitlab.opensourceecology.de/verein/projekte/cab/CAB/-/blob/main/Templates)) at the top of the readme file.
|
|
```
|
|
|
|
|
**Push an existing git repository**
|
|
|
### Projects in Review Stage
|
|
```
|
|
|
Projects for assessment will use two different branches. The original files will be in the **main branch**. The assessment will take place in the **review branch**. Once it is finished the review branch will be merged into the main issue using the final tag.
|
|
cd existing_repo
|
|
|
```
|
|
git remote rename origin old-origin
|
|
|
git remote rename master main
|
|
git remote add origin ssh://git@gitlab.opensourceecology.de:2222/verein/projekte/cab/ohloom.git
|
|
|
git checkout -b review
|
|
git push -u origin --all
|
|
|
```
|
|
git push -u origin --tags
|
|
|
Eventually you may want to protect the reviewer branch, so reviewers (with developer rights) can only enter changes by merge requests. Additionally the release tag can be set as protected.
|
|
```
|
|
|
|
|
#### Assessment Header
|
|
|
#### Add Review Issues
|
|
Add and fill the [assessment header](https://gitlab.opensourceecology.de/verein/projekte/cab/CAB/-/blob/main/Templates/assessment-header.md) (in Folder [Templates](https://gitlab.opensourceecology.de/verein/projekte/cab/CAB/-/blob/main/Templates)) at the top of the readme file.
|
|
|
Add the Review Issues as described in the [Template Guide](2-Guides/issue-templates-guide).
|
|
|
|
|
|
|
### Projects in Review Stage
|
|
|
The next step towards the assessment will be to create the initial issues for review. Therefore continue with the [template-guide](/2-Guides/issue-templates-guide). Eventually you might want to add some members first:
|
|
Projects for assessment will use two different branches. The original files will be in the **main branch**. The assessment will take place in the **review branch**. Once it is finished the review branch will be merged into the main issue using the final tag.
|
|
|
|
|
```
|
|
|
## Adding members
|
|
git remote rename master main
|
|
|
New participants need an GitLab Account. Therefore they need to fill out this [form](https://cloud.opensourceecology.de/apps/forms/xiEwEFzwkXdHBqXz). After this happened the IT Administration Team needs a quick reminder to get the data and create the account.
|
|
git checkout -b review
|
|
|
|
|
```
|
|
|
Add new members to the project. Start by adding members as guest in the [CAB Group](https://gitlab.opensourceecology.de/verein/projekte/cab), so they can be found within the sub-projects. The following roles and access rights are used within the CAB:
|
|
Eventually you may want to protect the reviewer branch, so reviewers (with developer rights) can only enter changes by merge requests. Additionally the release tag can be set as protected.
|
|
|
|
|
|
|
|
- **CAB-Admins**
|
|
#### Add Review Issues
|
|
|
- Tasks: CAB-Administration, Manage Members, Onboarding, Add projects, Add issues, Finalise Assessment
|
|
Add the Review Issues as described in the [Template Guide](2-Guides/issue-templates-guide).
|
|
|
- Access rights
|
|
|
|
|
- CAB Group: Owner (Invite members, Create Subgroups, Set project visibility)
|
|
The next step towards the assessment will be to create the initial issues for review. Therefore continue with the [template-guide](/2-Guides/issue-templates-guide). Eventually you might want to add some members first:
|
|
|
- CAB Repo: Maintainer (Administration, Right Management) - inherited
|
|
|
|
|
- Project Repo: Maintainer (Create, edit, close issues) - inherited
|
|
## Adding members
|
|
|
- **Reviewer**
|
|
New participants need an GitLab Account. Therefore they need to fill out this [form](https://cloud.opensourceecology.de/apps/forms/xiEwEFzwkXdHBqXz). After this happened the IT Administration Team needs a quick reminder to get the data and create the account.
|
|
|
- Tasks: Durchführen der Reviews, ggf. Anpassungen vorschlagen
|
|
|
|
|
- Access rights
|
|
Add new members to the project. Start by adding members as guest in the [CAB Group](https://gitlab.opensourceecology.de/verein/projekte/cab), so they can be found within the sub-projects. The following roles and access rights are used within the CAB:
|
|
|
- CAB Group: Guest (Member visibilty)
|
|
|
|
|
- CAB Repo: Guest (Create issues, comment, create merge requests) - inherited
|
|
- **CAB-Admins**
|
|
|
- Project Repo: Developer (create, edit, close issues, create and accept merge requests)
|
|
- Tasks: CAB-Administration, Manage Members, Onboarding, Add projects, Add issues, Finalise Assessment
|
|
|
- hint: Subgroup Reviewer can be used to give all reviewers automatic access to the project
|
|
- Access rights
|
|
|
- **Applicants** (at least one)
|
|
- CAB Group: Owner (Invite members, Create Subgroups, Set project visibility)
|
|
|
- Tasks: Project contact, bugfixing, create and accept merge requests
|
|
- CAB Repo: Maintainer (Administration, Right Management) - inherited
|
|
|
- Access rights
|
|
- Project Repo: Maintainer (Create, edit, close issues) - inherited
|
|
|
- CAB Group: Guest (Member visibilty)
|
|
- **Reviewer**
|
|
|
- CAB Repo: Guest (Create issues, comment, create merge requests) - inherited
|
|
- Tasks: Durchführen der Reviews, ggf. Anpassungen vorschlagen
|
|
|
- Project Repo: Developer (create, edit, close issues, create and accept merge requests)
|
|
- Access rights
|
|
|
- Applicants will be assigned to single projects only
|
|
- CAB Group: Guest (Member visibilty)
|
|
|
- Additonal Developers will be added as applicants
|
|
- CAB Repo: Guest (Create issues, comment, create merge requests) - inherited
|
|
|
- CAB-Entwicklung
|
|
- Project Repo: Developer (create, edit, close issues, create and accept merge requests)
|
|
|
- Tasks: Development of the Workflow
|
|
- hint: Subgroup Reviewer can be used to give all reviewers automatic access to the project
|
|
|
- Access rights
|
|
- **Applicants** (at least one)
|
|
|
- CAB Group: Guest (Member visibilty)
|
|
- Tasks: Project contact, bugfixing, create and accept merge requests
|
|
|
- CAB Repo: Reporter (Create issues, comment, create merge requests)
|
|
- Access rights
|
|
|
|
|
- CAB Group: Guest (Member visibilty)
|
|
|
## Guiding the Assessment
|
|
- CAB Repo: Guest (Create issues, comment, create merge requests) - inherited
|
|
|
As CAB-Admin one of your main responsibility is to observe the assessment process. After creating the templates the review will start. Once all sub-issues are resolved it is up to you to doublecheck if everything was approved by the assigned reviewers. Once this is made sure you can initiate the release.
|
|
- Project Repo: Developer (create, edit, close issues, create and accept merge requests)
|
|
|
|
|
- Applicants will be assigned to single projects only
|
|
|
Hint: In theory it is possible that some else then the assigend reviewers sets the checkboxes. Although this is very unlikely you will have to make sure that everything was approved accordingly.
|
|
- Additonal Developers will be added as applicants
|
|
|
|
|
- CAB-Entwicklung
|
|
|
### Assessment Release
|
|
- Tasks: Development of the Workflow
|
|
|
[ToDo]
|
|
- Access rights
|
|
|
|
|
- CAB Group: Guest (Member visibilty)
|
|
|
# Quick Check
|
|
- CAB Repo: Reporter (Create issues, comment, create merge requests)
|
|
|
Short checklists for the CAB-Admin tasks.
|
|
|
|
|
## Add new project
|
|
## Guiding the Assessment
|
|
|
- Check [requirements for application](/2-Guides/application-guide)
|
|
As CAB-Admin one of your main responsibility is to observe the assessment process. After creating the templates the review will start. Once all sub-issues are resolved it is up to you to doublecheck if everything was approved by the assigned reviewers. Once this is made sure you can initiate the release.
|
|
|
- Add project in [Assessment overview](https://gitlab.opensourceecology.de/verein/projekte/cab/CAB/-/blob/main/archive/assessments.md)
|
|
|
|
|
- Create [Assessment][projectname] issue in [Project Assessment Milestone](https://gitlab.opensourceecology.de/verein/projekte/cab/CAB/-/milestones/3)
|
|
Hint: In theory it is possible that some else then the assigend reviewers sets the checkboxes. Although this is very unlikely you will have to make sure that everything was approved accordingly.
|
|
|
- Clone the project into https://gitlab.opensourceecology.de/verein/projekte/cab
|
|
|
|
|
- (Name the project like in original, adding the version number )
|
|
### Assessment Release
|
|
|
- Create and fill the [assessment header](https://gitlab.opensourceecology.de/verein/projekte/cab/CAB/-/blob/main/Templates/assessment-header.md) in the readme
|
|
[ToDo]
|
|
|
- Eventually add new members, then continue with [template-guide](/2-Guides/issue-templates-guide)
|
|
|
|
|
|
|
# Quick Check
|
|
|
## Add new member
|
|
Short checklists for the CAB-Admin tasks.
|
|
|
- Send the interested member the member-form and have it filled
|
|
## Add new project
|
|
|
- Add members as "guest" in the [CAB Group](https://gitlab.opensourceecology.de/verein/projekte/cab)
|
|
- Check [requirements for application](/2-Guides/application-guide)
|
|
|
- Add them according to the [Role-Permissions](#adding-members)
|
|
- Add project in [Assessment overview](https://gitlab.opensourceecology.de/verein/projekte/cab/CAB/-/blob/main/archive/assessments.md)
|
|
|
|
|
- Create [Assessment][projectname] issue in [Project Assessment Milestone](https://gitlab.opensourceecology.de/verein/projekte/cab/CAB/-/milestones/3)
|
|
|
## Assessment
|
|
- Clone the project into https://gitlab.opensourceecology.de/verein/projekte/cab
|
|
|
|
- (Name the project like in original, adding the version number )
|
|
|
|
- Create and fill the [assessment header](https://gitlab.opensourceecology.de/verein/projekte/cab/CAB/-/blob/main/Templates/assessment-header.md) in the readme
|
|
|
|
- Eventually add new members, then continue with [template-guide](/2-Guides/issue-templates-guide)
|
|
|
|
|
|
|
|
## Add new member
|
|
|
|
- Send the interested member the member-form and have it filled
|
|
|
|
- Add members as "guest" in the [CAB Group](https://gitlab.opensourceecology.de/verein/projekte/cab)
|
|
|
|
- Add them according to the [Role-Permissions](#adding-members)
|
|
|
|
|
|
|
|
## Assessment
|
|
|
[ToDo] |
|
[ToDo] |
|
|
|
\ No newline at end of file |
