readme:chore - Added new fixes to readme (#730)

* Added new fixes to readme Signed-off-by: jessica-tw <jessica.olinda@zup.com.br>
ZupIT · Nov 16, 2021 · 6044637 · 6044637
1 parent a76b74f
commit 6044637
Show file tree

Hide file tree

Showing 3 changed files with 91 additions and 66 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -3,31 +3,28 @@
 This is Horusec contributing guide. Please read the following sections to learn how to ask questions and how to work on something.
 
 ## **Table of contents**
-1. [**Getting Started**](#Getting-started)
-   1. [**Before you contribute**](#Before-you-contribute)
-   2. [**Code of Conduct**](#Code-of-Conduct)
-   3. [**Legal**](#Legal)
-2. [**Prerequisites**](#Prerequisites)
-   1. [**Developer Certificate of Origin**](#Developer-Certificate-of-Origin)
-   2. [**Code Review**](#Code-Review)
-   3. [**Pull Requests**](#Pull-Requests)    
-3. [**How to contribute?**](#How-to-contribute?)
-      1. [**Prepare your development environment**](#Prepare-your-development-environment)
-      2. [**First contribution**](#First-contribution)
-      4. [**Add new feature, bugfixing or improvement**](#Add-new-feature-bugfixing-or-improvement)
-      5. [**Pull Request's approval**](#Pull-Request's-approval)
-      6. [**After your pull request's approval**](#After-your-pull-request's-approval)
-4. [**Community**](#Community)
-
-## **Getting started**
-
-### **Before you contribute**
+### 1. [**Before you contribute**](#before-you-contribute)
+> #### 1.1.  [**Code of Conduct**](#code-of-conduct)
+> #### 1.2. [**Legal**](#legal)
+### 2. [**Prerequisites**](#prerequisites)
+> #### 2.1.   [**Developer Certificate of Origin**](#developer-certificate-of-origin)
+> #### 2.2.  [**Code Review**](#code-review)
+> #### 2.3. [**Pull Requests**](#pull-requests)    
+### 3. [**How to contribute?**](#how-to-contribute?)
+ > #### 3.1. [**Prepare your development environment**](#prepare-your-development-environment)
+> #### 3.2.  [**First contribution**](#first-contribution)
+> #### 3.3. [**Add new feature, bug fixing or improvement**](#add-new-feature-bugfixing-or-improvement)
+> #### 3.4.  [**Pull Request's approval**](#pull-request-approval)
+> #### 3.5.   [**After your pull request's approval**](#after-your-pull-request-approval)
+### 4. [**Community**](#community)
+
+## **Before you contribute**
 
 ### **Code of Conduct**
 Please follow the [**Code of Conduct**](https://github.com/ZupIT/horusec/blob/main/CODE_OF_CONDUCT.md) in all your interactions with our project.
 
 ### **Legal**
-- Horusec is licensed over [**ASL - Apache License**](https://github.com/ZupIT/charlescd/blob/main/LICENSE), version 2, so new files must have the ASL version 2 header. For more information, please check out [**Apache license**](https://www.apache.org/licenses/LICENSE-2.0).
+- Horusec is licensed over [**ASF - Apache License**](https://github.com/ZupIT/horusec/blob/main/LICENSE), version 2, so new files must have the ASF version 2 header. For more information, please check out [**Apache license**](https://www.apache.org/licenses/LICENSE-2.0).
 
 - All contributions are subject to the [**Developer Certificate of Origin (DCO)**](https://developercertificate.org). 
 When you commit, use the ```**-s** ``` option to include the Signed-off-by line at the end of the commit log message.
@@ -39,46 +36,65 @@ Check out the requisites before contributing to Horusec:
 
  This is a security layer for the project and for the developers. It is mandatory.
 
- There are two ways to use DCO, see them below: 
+ Follow one of these two methods to add DCO to your commits:
 
 **1. Command line**
  Follow the steps: 
- **Step 1:** Check out your local git:
+ **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.
 
  ```
 git config --global user.name “Name”
 git config --global user.email “email@domain.com.br”
 ```
-**Step 2:** When you commit, add the sigoff via `-s` flag:
+**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**
 
-**Step 1:** When the commit changes box opens, add 
+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:
+
 ```
-$ git commit -m “My signed commit” Signed-off-by: username <email address>
+Signed-off-by: Name < e-mail address >
 ```
-Note: For this option, your e-mail must be the same in registered in GitHub. 
+
+For this method, your name and e-mail must be the same registered on your GitHub account.
 
 ### **Code Review**
 - All your submissions needs a review.
 
 ### **Pull Requests**
-When you open a PR, follow the requisites below:
-- You need to add a title describing the issue. 
-- Answer the questions about what you did, how to verify it and a description for the changelog, see an example:
+When you open a Pull Request, follow the requirements below:
+
+1. Add a title with the following pattern: 
+
+#### **[PKG][TYPE]: Description**
+
+#### **PKG:** Name of the package or main service you want to change.
+
+#### **TYPE**: Add what your Pull Request (PR) refers to:
+- **FEATURE:** PR refers to a new activity.
+- **BUGFIX:** PR refers to corrections for the next release.
+- **HOTFIX:** PR refers to corrections where you will need a cherry-pick and the update of the minor version. 
+- **CHORE:** PR refers to changes for the next release, but it was only maintenance without an activity impact.  
+
+**Example:** **[start][bugfix]: Fix bug when Horusec haven't read the new flag of authorization**
+
+
+2. Answer the questions about what you did, how to verify it and a short description for the changelog, see an example below:
 
-<p align="center" margin="20 0"><img src="assets/horusec-pr.PNG" alt="architecture" width="100%" style="max-width:100%;"/></p>
+<p align="center" margin="20 0"><img src="assets/pr-template.PNG" alt="architecture" width="100%" style="max-width:100%;"/></p>
 
 
 ## **How to contribute?** 
 See the guidelines to submit your changes: 
 
 ### **Prepare your development environment**
-To start contributing with Horusec you first need to install [Go](https://golang.org/dl/). The minimal version required to build is 1.17.
-[GNU Make](https://www.gnu.org/software/make/) is also required to development.
+To start contributing with Horusec, you need to install [**Go**](https://golang.org/dl/). The minimal version required to build is 1.17.
+[**GNU Make**](https://www.gnu.org/software/make/) is also required to development.
 
 After installing Go you can build using `make build-dev`.
 
@@ -106,7 +122,6 @@ go tool cover -html=coverage.out # Open coverage status in your browser
 #### **Repositories**
 Horusec has other repositories and you can check the README for each one of them: 
 
-- [**Admin**](https://github.com/ZupIT/horusec-admin)
 - [**Charts**](https://github.com/ZupIT/charlescd/tree/main/circle-matcher)
 - [**Devkit**](https://github.com/ZupIT/horusec-devkit)
 - [**Engine**](https://github.com/ZupIT/horusec-engine)
@@ -122,7 +137,7 @@ Contributing to a new feature is only allowed in the [**main repository**](https
 
 Before contributing to this repository, please discuss the changes you wish to make via e-mail or [**forum**](https://forum.zup.com.br/c/en/horusec/14). 
 
-### **Add new feature, bugfixing or improvement**
+### **Add new feature, bug fixing or improvement**
 If you want to add an improvement, a new feature or bugfix, follow the steps to contribute: 
 
 **Step 1:** Make sure your branch is based on main;

diff --git a/README.md b/README.md
@@ -26,29 +26,31 @@
 </p>
 
 ## **Table of contents**
-1. [**What is Horusec?**](#What-is-Horusec?)
-2. [**Getting started**](#Getting-started)
-    1. [**Requirements**](#Requirements)
-    2. [**Installing Horusec**](#Installing-Horusec)
-    3. [**Usage**](#Usage)
-        1. [**CLI Usage**](#CLI-Usage)
-        2. [**Using Docker**](#Using-Docker)
-        3. [**Older versions**](#Older-versions)
-        4. [**Using Horusec-Web application**](#Using-Horusec-Web-application)
-        5. [**Using Visual Studio Code**](#Using-Visual-Studio-Code)
-        6. [**Using the Pipeline**](#Using-the-Pipeline)
-4. [**Contributing**](#Contributing)
-5. [**Roadmap**](#Community)
-6. [**License**](#License)
-7. [**Community**](#Community)
+### 1. [**About**](#about)
+### 2. [**Getting started**](#getting-started)
+>#### 2.1.   [**Requirements**](#requirements)
+>#### 2.2.  [**Installation**](#installing-horusec)
+### 3. [**Usage**](#usage)
+>#### 3.1. [**CLI Usage**](#cli-usage)
+>#### 3.2. [**Using Docker**](#using-docker)
+>#### 3.3. [**Older versions**](#older-versions)
+>#### 3.4. [**Using Horusec-Web application**](#using-horusec-web-application)
+>#### 3.5.  [**Using Visual Studio Code**](#using-visual-studio-code)
+>#### 3.6. [**Using the Pipeline**](#using-the-pipeline)
+### 4. [**Documentation**](#documentation)       
+### 5. [**Roadmap**](#roadmap)
+### 6. [**Contributing**](#contributing)
+### 7. [**Code of Conduct**](#code-of-conduct)
+### 8. [**License**](#license)
+### 9. [**Community**](#community)
 
 
 
 <br>
 <br>
 <br>
 
-# **What is Horusec?**
+# **About**
 Horusec is an open source tool that performs a static code analysis to identify security flaws during the development process. Currently, the languages for analysis are C#, Java, Kotlin, Python, Ruby, Golang, Terraform, Javascript, Typescript, Kubernetes, PHP, C, HTML, JSON, Dart, Elixir, Shell, Nginx. 
 The tool has options to search for key leaks and security flaws in all your project's files, as well as in Git history. Horusec can be used by the developer through the CLI and by the DevSecOps team on CI /CD mats. 
 
@@ -168,6 +170,19 @@ See below:
 - Search for their historical git by secrets and other contents exposed;
 - Your analysis can be fully configurable, [**see all CLI available resources**](https://horusec.io/docs/cli/resources/#3-flags).
 
+## **Documentation**
+You can find Horusec's documentation on our [**website**](https://horusec.io/docs/).
+
+## **Roadmap**
+We have a project [**roadmap**](ROADMAP.md), you can contribute with us!
+
+Horusec has other repositories, check them out:
+
+- [**Horusec Platform**](https://github.com/ZupIT/horusec-platform)
+- [**Horusec DevKit**](https://github.com/ZupIT/horusec-devkit)
+- [**Horusec Engine**](https://github.com/ZupIT/horusec-engine)
+- [**Horusec Operator**](https://github.com/ZupIT/horusec-operator)
+- [**Horusec VsCode**](https://github.com/ZupIT/horusec-vscode-plugin)
 
 ## **Contributing**
 
@@ -179,40 +194,35 @@ Check out our [**contributing guide**](CONTRIBUTING.md) to learn about our devel
 
  This is a security layer for the project and for the developers. It is mandatory.
 
- There are two ways to use DCO, see them below: 
+Follow one of these two methods to add DCO to your commits:
 
 **1. Command line**
  Follow the steps: 
- **Step 1:** Check out your local git:
+ **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.
 
  ```
 git config --global user.name “Name”
 git config --global user.email “email@domain.com.br”
 ```
-**Step 2:** When you commit, add the sigoff via `-s` flag:
+**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**
 
-**Step 1:** When the commit changes box opens, add 
+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:
+
 ```
-$ git commit -m “My signed commit” Signed-off-by: username <email address>
+Signed-off-by: Name < e-mail address >
 ```
-Note: For this option, your e-mail must be the same in registered in GitHub. 
 
-## **Roadmap**
-We have a project [**roadmap**](ROADMAP.md), you can come contribute with us!
+For this method, your name and e-mail must be the same registered on your GitHub account.
 
-Horusec also have other repositories, check out some of our other projects:
-
-- [**Horusec Platform**](https://github.com/ZupIT/horusec-platform)
-- [**Horusec DevKit**](https://github.com/ZupIT/horusec-devkit)
-- [**Horusec Engine**](https://github.com/ZupIT/horusec-engine)
-- [**Horusec Operator**](https://github.com/ZupIT/horusec-operator)
-- [**Horusec Admin**](https://github.com/ZupIT/horusec-admin)
-- [**Horusec VsCode**](https://github.com/ZupIT/horusec-vscode-plugin)
+## **Code of Conduct**
+Please follow the [**Code of Conduct**](https://github.com/ZupIT/horusec/blob/main/CODE_OF_CONDUCT.md) in all your interactions with our project.
 
 ## **License**
  [**Apache License 2.0**](LICENSE).

diff --git a/assets/pr-template.PNG b/assets/pr-template.PNG