Commit 6889944e authored by Maximilian Dolling's avatar Maximilian Dolling

updated docs

parent f8c03366
......@@ -20,11 +20,11 @@ Either via the [GitLab CI/CD](https://docs.gitlab.com/ee/ci/) (recommended) or a
> **Example:** You can find a full report of all available services [here](meta/software-quality-assurance-report.md)
**Current available services:**
* Programming Language Detection
* Credential Check
* License Check
* Report Generation
* List Authors
* Programming Language Detection
* Report Generation
---
## Requirements
......@@ -70,14 +70,10 @@ You can find a detailed description of all implemented services [here](doc/doc_s
* JavaScript
* C, C++
* Matlab
* license header check
* license generation
* comment check
* check for necessary files
* generate necessary files
* check if tests exist
* credential check
* DOI request
* curate meta data
---
......@@ -11,6 +11,7 @@ SPDX-License-Identifier: CC0-1.0
## implemented services
* apply license
* check credetials
* generate-report
* list authors
* list used languages
......@@ -39,6 +40,20 @@ Here we categorized all files into 4 categories:
It inits `reuse` and downloads all used license texts to a folder `LICENSE`.
Afterwards it generates a license header or a .license file for every file in the repository.
---
### check credentials
This service implements a wrapper for the [gitleaks tool](https://github.com/zricethezav/gitleaks).
gitleaks can be configured with its own config file.
Please see the gitleaks documentation for its config.
The source code can be found [here](../src/services/check-credentials).
> **Note:** When the init procedure is ran, the default config for `gitleaks` is created.
>A adequate general rule to detect leaks is commented out.
>Uncomment it at your will.
---
### generate report
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment