From 706d0d9d72de5df2a0692459d12dd0a006f11dbd Mon Sep 17 00:00:00 2001
From: HenriqueZup <95223206+HenriqueZup@users.noreply.github.com>
Date: Tue, 21 Dec 2021 11:18:22 -0300
Subject: [PATCH] docs:feature - add build markdown file (#144)

Signed-off-by: Henrique Rodrigues <henrique.rodrigues@zup.com.br>
---
 BUILD.md | 83 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 83 insertions(+)
 create mode 100644 BUILD.md

diff --git a/BUILD.md b/BUILD.md
new file mode 100644
index 0000000..256acc0
--- /dev/null
+++ b/BUILD.md
@@ -0,0 +1,83 @@
+# **BUILD**
+
+## **Table of contents** 
+### 1. [**About**](#about)
+### 2. [**Environment**](#environment)
+### 3. [**Development**](#development)
+>#### 3.1. [**Style Guide**](#style-guide)
+>#### 3.2. [**Tests**](#tests)
+>#### 3.3. [**Security**](#security)
+
+## **About**
+
+The **BUILD.md** is a file to check the environment and build specifications of **horusec-devkit** project.
+
+
+## **Environment**
+
+- [**Golang**](https://go.dev/dl/): ^1.17.X
+- [**GNU Make**](https://www.gnu.org/software/make/): ^4.2.X
+
+## **Development**
+
+Horusec-DevKit is the repository where there are some abstractions that the Horusec team uses to simplify development and testing.
+
+You can use it as a package by running the following command in your Golang project:
+
+```bash
+go get github.com/ZupIT/horusec-devkit
+```
+
+### **Style Guide**
+
+For source code standardization, the project uses the [**golangci-lint**](https://golangci-lint.run) tool as a Go linter aggregator. You can check the lint through the `make` command available in each microservice:
+
+```bash
+make lint
+```
+
+To perform the indentation and removal of unused code automatically, just run the following command:
+
+```bash
+make format
+```
+
+The project also has a pattern of dependency imports, and the command below organizes your code in the pattern defined by the Horusec team, this command must be run in each microservice:
+
+```bash
+make fix-imports
+```
+
+All project files must have the [**license header**](./copyright.txt). You can check if all files are in agreement by running the following command in project root:
+
+```bash
+make license
+```
+
+If it is necessary to add the license in any file, run the command below to insert it in all files that do not have it:
+
+```bash
+make license-fix
+```
+
+### **Tests**
+
+The unit tests were written with the [**standard package**](https://pkg.go.dev/testing) and some mock and assert snippets, we used the [**testify**](https://github.com/stretchr/testify). You can run the tests using the command below:
+
+```bash
+make test
+```
+
+To check test coverage, run the command below:
+
+```bash
+make coverage
+```
+
+### **Security**
+
+We use the latest version of [**Horusec-CLI**](https://github.com/ZupIT/horusec) to maintain the security of our source code. Through the command below, you can perform this verification in the project:
+
+```bash
+make security
+```