Skip to content
This repository has been archived by the owner on Jun 1, 2024. It is now read-only.

Commit

Permalink
Fixed Readme file (#7)
Browse files Browse the repository at this point in the history
Signed-off-by: jessica-tw <[email protected]>
  • Loading branch information
jessica-tw authored Dec 27, 2021
1 parent 9a53f3a commit d81921e
Showing 1 changed file with 44 additions and 17 deletions.
61 changes: 44 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
# **Horusec Jenkins Shared Library**
This project holds all the code you need to run Horusec CLI in your Jenkins deployment.

For more information about Shared Libraries and how to use them in your Jenkins deployment, [**check out their documentation**](https://www.jenkins.io/doc/book/pipeline/shared-libraries/).
## **Table of contents**
### 1. [**About**](#about)
### 2. [**Documentation**](#documentation)
### 3. [**Contributing**](#contributing)
### 4. [**License**](#license)
### 5. [**Community**](#community)

## **About**
This project holds all the code you need to run Horusec-CLI in your Jenkins deployment.

For more information about Shared Libraries and how to use them in your Jenkins deployment, [**check out the documentation**](https://www.jenkins.io/doc/book/pipeline/shared-libraries/).

## **Documentation**

Expand All @@ -11,25 +19,44 @@ For more information about Horusec, please check out the [**documentation**](htt

## **Contributing**

If you want to contribute to this repository, access our [**Contributing Guide**](https://github.com/ZupIT/charlescd/blob/main/CONTRIBUTING.md).
And if you want to know more about Horusec, check out some of our other projects:
If you want to contribute to this repository, access our [**Contributing Guide**](https://github.com/ZupIT/horusec/blob/main/CONTRIBUTING.md).

### **Developer Certificate of Origin - DCO**

- [**Admin**](https://github.com/ZupIT/horusec-admin)
- [**Charts**](https://github.com/ZupIT/charlescd/tree/main/circle-matcher)
- [**Devkit**](https://github.com/ZupIT/horusec-devkit)
- [**Jenkins**](https://github.com/ZupIT/horusec-jenkins-sharedlib)
- [**Operator**](https://github.com/ZupIT/horusec-operator)
- [**Platform**](https://github.com/ZupIT/horusec-platform)
- [**VSCode plugin**](https://github.com/ZupIT/horusec-vscode-plugin)
- [**Kotlin**](https://github.com/ZupIT/horusec-tree-sitter-kotlin)
- [**Vulnerabilities**](https://github.com/ZupIT/horusec-examples-vulnerabilities)
This is a security layer for the project and for the developers. It is mandatory.

Follow one of these two methods to add DCO to your commits:

**1. Command line**
Follow the steps:
**Step 1:** Configure your local git environment adding the same name and e-mail configured at your GitHub account. It helps to sign commits manually during reviews and suggestions.

## **Community**
Feel free to reach out to us at:
```
git config --global user.name “Name”
git config --global user.email “[email protected]
```
**Step 2:** Add the Signed-off-by line with the `'-s'` flag in the git commit command:

```
$ git commit -s -m "This is my commit message"
```

**2. GitHub website**
You can also manually sign your commits during GitHub reviews and suggestions, follow the steps below:

**Step 1:** When the commit changes box opens, manually type or paste your signature in the comment box, see the example:

- [**GitHub Issues**](https://github.com/ZupIT/horusec-devkit/issues)
- [**Zup Open Source Forum**](https://forum.zup.com.br)
```
Signed-off-by: Name < e-mail address >
```

For this method, your name and e-mail must be the same registered on your GitHub account.

## **License**
[**Apache License 2.0**](https://github.com/ZupIT/horusec/blob/main/LICENSE).

## **Community**
Do you have any question about Horusec? Let's chat in our [**forum**](https://forum.zup.com.br/).


This project exists thanks to all the contributors. You rock! ❤️🚀

0 comments on commit d81921e

Please sign in to comment.