Skip to content

Commit b4523a5

Browse files
Closes #363
Added descriptions to some sheets and updated to ensure markdown.
1 parent 83b0ab3 commit b4523a5

File tree

2 files changed

+59
-16
lines changed

2 files changed

+59
-16
lines changed

Development.md

Lines changed: 33 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,64 @@
1-
# DSOMM
1+
# DevSecOps Maturity Model (DSOMM)
2+
3+
## Introduction
4+
5+
The DevSecOps Maturity Model (DSOMM) is an open-source framework designed to help organizations evaluate and improve their **DevSecOps** practices.
6+
It provides structured **security maturity levels**, recommendations, and automation insights to enable teams to build **secure, efficient, and scalable software**.
7+
8+
This guide walks you through **setting up the project locally**, making contributions, and submitting a pull request.
9+
10+
## **Project Setup**
11+
12+
### Development Server :-
213

3-
## Development server
414
The DSOMM is based [Angular](https://angular.dev/) and uses npm for package management.
15+
516
- If you have not yet installed npm or the Angular command line tools, install them now. First [NodeJS](https://nodejs.org/en/download) (which provides npm), then Angular:
6-
```
17+
18+
```bash
719
npm install -g @angular/cli
8-
```
9-
- Clone the DSOMM repo
1020
```
21+
22+
- Clone the DSOMM repo
23+
24+
```bash
1125
git clone https://github.com/devsecopsmaturitymodel/DevSecOps-MaturityModel.git
1226
```
27+
1328
- Change directory to DSOMM
14-
```
29+
30+
```bash
1531
cd DevSecOps-MaturityModel
1632
```
33+
1734
- Install Dependencies
18-
```
35+
36+
```bash
1937
npm install
2038
```
39+
2140
- **NB!** The DSOMM activities are maintained separately. Download the `generated.yaml` and put it in the required folder
22-
```
41+
42+
```bash
2343
curl https://raw.githubusercontent.com/devsecopsmaturitymodel/DevSecOps-MaturityModel-data/main/src/assets/YAML/generated/generated.yaml -o src/assets/YAML/generated/generated.yaml
2444
```
2545

2646
- Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
2747

28-
29-
## Code scaffolding
48+
### Code scaffolding :-
3049

3150
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
3251

33-
## Build
52+
### Build :-
3453

3554
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
3655

37-
## Running unit tests
56+
### Running unit tests :-
3857

3958
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
4059

41-
## Coding Style Conventions
60+
### Coding Style Conventions :-
4261

43-
- We follow the coding style defined by [ESLint](https://eslint.org/).
62+
- We follow the coding style defined by [ESLint](https://eslint.org/).
4463
- We also use [Prettier](https://prettier.io/docs/en/index.html) as our opinionated code formatter.
4564
- To validate the schemas of the DSOMM yaml files in the IDE, it is recommended to use the VS Code extension [redhat.vscode-yaml](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml). The schemas are stored in /src/assets/YAML/schemas
46-
Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,26 @@
1-
In this folder, the generated.yaml will be placed
1+
# Generated YAML Files
2+
3+
This folder contains the `generated.yaml` file, which is dynamically created during the build process.
4+
It stores configuration settings and other automatically generated data used by the DevSecOps Maturity Model (DSOMM).
5+
6+
## **What is `generated.yaml`?**
7+
8+
- It is a machine-generated file that is **not meant to be manually edited**.
9+
- It helps in **storing configuration settings**, which are loaded at runtime.
10+
- Used by the application to dynamically configure settings.
11+
12+
## **How is it Generated?**
13+
14+
The `generated.yaml` file is created as part of the DevSecOps Maturity Model’s **build process**. If you don’t see this file after setup, make sure to run:
15+
16+
```sh
17+
npm run build
18+
```
19+
20+
or
21+
22+
```sh
23+
yarn build
24+
```
25+
26+
This will generate the required **YAML** file.

0 commit comments

Comments
 (0)