From 2911bc44d038fa789da0404693c489cccd61a908 Mon Sep 17 00:00:00 2001 From: jessica-tw Date: Fri, 19 Nov 2021 13:04:31 -0300 Subject: [PATCH 1/2] Fixes Signed-off-by: jessica-tw --- CONTRIBUTING.md | 29 ++++++++++++++--------------- README.md | 15 +++------------ 2 files changed, 17 insertions(+), 27 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 579597a..cf1ade6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,17 +2,17 @@ This is Beagle's contributing guide. You will find here some resources to help you contribute. ## **Table of contents** -### 1. [**Before you contribute**](#Before-you-contribute) -> #### 1.1. [**Code of Conduct**](#Code-of-Conduct) -> #### 1.2. [**Legal**](#Legal) -### 2. [**Prerequisites**](#Prerequisites) ->#### 2.1. [**Pull Request title**](#Pull-Request-title) -> #### 2.2. [**Developer Certificate of Origin**](#Developer-Certificate-of-Origin) -### 3. [**How to contribute?**](#How-to-contribute?) ->#### 3.1. [**How can you contribute?**](#What-can-you-contribute?) ->#### 3.2. [**Contribution Guideline**](#Contribution-Guideline) ->#### 3.3. [**Pull Request's approval**](#Pull-Request's-approval) -### 4. [**Community**](#Community) +### 1. [**Before you contribute**](#before-you-contribute) +> #### 1.1. [**Code of Conduct**](#code-of-Conduct) +> #### 1.2. [**Legal**](#legal) +### 2. [**Prerequisites**](#prerequisites) +> #### 2.1. [**Pull Request title**](#pull-request-title) +> #### 2.2. [**Developer Certificate of Origin**](#developer-certificate-of-origin) +### 3. [**How to contribute?**](#how-to-contribute?) +>#### 3.1. [**How can you contribute?**](#what-can-you-contribute?) +>#### 3.2. [**Contribution Guideline**](#contribution-Guideline) +>#### 3.3. [**Pull Request's approval**](#pull-Request's-approval) +### 4. [**Community**](#community) ## **Before you contribute** @@ -30,7 +30,7 @@ When you commit, use the ```**-s** ``` option to include the Signed-off-by line Check out the requisites before contributing to Beagle: ### **Pull Request title** -When opening a PR, add the title with a prefix of the type of change you are contributing, for example `feat:` for a new feature. You can see other types in the [**What can you contribute?**](#What-can-you-contribute?) section. +When opening a PR, add the title with a prefix of the type of change you are contributing, for example `feat:` for a new feature. You can see other types in the [**How can you contribute?**](#how-can-you-contribute?) section. Your Pull Request should look like this: @@ -70,7 +70,7 @@ You can also manually sign your commits during GitHub reviews and suggestions, f Signed-off-by: Name < e-mail address > ``` -For this method, your name and e-mail must be the same registered to your GitHub account. +For this method, your name and e-mail must be the same registered on your GitHub account. ## **How to contribute?** See the guidelines to submit your changes. @@ -128,9 +128,8 @@ After Beagle's team analyze your contribution, we may add some questions and sug ## **Community** -- Do you have any question about Beagle? Let's chat in our [**forum**](https://forum.zup.com.br/c/en/beagle/12). +- Do you have any question about Beagle? Let's chat in our [**forum**](https://forum.zup.com.br/c/en/horusec/14). **Thank you for your contribution!** -**Beagle Team** 😁 diff --git a/README.md b/README.md index 33ec8a3..994bdfa 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,9 @@ -# [**Beagle**](https://usebeagle.io/) · [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/ZupIT/beagle-backend-kotlin/blob/main/LICENSE.txt) [![maven version](https://img.shields.io/maven-central/v/br.com.zup.beagle/framework)](https://search.maven.org/artifact/br.com.zup.beagle/framework) [![CI/CD Status](https://github.com/ZupIT/beagle-android/actions/workflows/android-pr.yml/badge.svg?branch=main)](https://github.com/ZupIT/beagle-backend-kotlin/actions/workflows/backend-pr.yml) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/ZupIT/beagle-backend-kotlin/blob/main/CONTRIBUTING.md) [![Coverage Backend](https://sonarcloud.io/api/project_badges/measure?project=ZupIT_beagle_backend&metric=coverage)](https://sonarcloud.io/dashboard?id=ZupIT_beagle_backend) -

- Getting Started - · - Learn the Basics - · - Contribute -

- -# **Beagle Backend Kotlin** +# [**Beagle Backend Kotlin**](https://usebeagle.io/) · [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/ZupIT/beagle-backend-kotlin/blob/main/LICENSE.txt) [![maven version](https://img.shields.io/maven-central/v/br.com.zup.beagle/framework)](https://search.maven.org/artifact/br.com.zup.beagle/framework) [![CI/CD Status](https://github.com/ZupIT/beagle-android/actions/workflows/android-pr.yml/badge.svg?branch=main)](https://github.com/ZupIT/beagle-backend-kotlin/actions/workflows/backend-pr.yml) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/ZupIT/beagle-backend-kotlin/blob/main/CONTRIBUTING.md) [![Coverage Backend](https://sonarcloud.io/api/project_badges/measure?project=ZupIT_beagle_backend&metric=coverage)](https://sonarcloud.io/dashboard?id=ZupIT_beagle_backend) ## **Table of Contents** ### 1. [**About**](#about) -### 2. [**Usage**](#-usage) +### 2. [**Usage**](#usage) >#### 2.1. [**Requirements**](#requirements) >#### 2.2. [**Installation**](#installation) ### 3. [**Documentation**](#documentation) @@ -96,7 +87,7 @@ Please read the [**code of conduct**](https://github.com/ZupIT/beagle-backend-ko ## **License** -[**Apache License 2.0**]( https://github.com/ZupIT/beagle-ios/blob/main/LICENSE.txt). +[**Apache License 2.0**](https://github.com/ZupIT/beagle-backend-kotlin/blob/main/LICENSE.txt). ## **Community** From 38574664e591dec358e08273680dbc05c3f1bffd Mon Sep 17 00:00:00 2001 From: jessica-tw Date: Fri, 19 Nov 2021 15:08:10 -0300 Subject: [PATCH 2/2] fix Signed-off-by: jessica-tw --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cf1ade6..6a1966e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -128,7 +128,7 @@ After Beagle's team analyze your contribution, we may add some questions and sug ## **Community** -- Do you have any question about Beagle? Let's chat in our [**forum**](https://forum.zup.com.br/c/en/horusec/14). +- Do you have any question about Beagle? Let's chat in our [**forum**](https://forum.zup.com.br/). **Thank you for your contribution!**