From b454f1765027aa77ad203499b6279a505147ea6d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jorge=20Garc=C3=ADa=20Rey?= Date: Tue, 19 Dec 2023 16:59:58 +0100 Subject: [PATCH 1/3] docs: improve readme MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jorge García Rey --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2135ca5..efda69e 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ +[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=InditexTech_gh-sherpa&metric=bugs)](https://sonarcloud.io/summary/new_code?id=InditexTech_gh-sherpa) +[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=InditexTech_gh-sherpa&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=InditexTech_gh-sherpa)[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=InditexTech_gh-sherpa&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=InditexTech_gh-sherpa) + # Sherpa extension for GitHub CLI -[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=InditexTech_gh-sherpa&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=InditexTech_gh-sherpa) +**Sherpa** for [GitHub CLI](https://github.com/cli/cli) makes it easy for you to **create branches** and **pull requests** +associated with any **GitHub or Jira issue**. -**Sherpa** extension for [GitHub CLI](https://github.com/cli/cli) helps you to **automate certain operations of the -development life cycle of a task**. +This extension retrieves the type of issue (_User Story_, _Bug_, _Technical Improvement_ etc) and creates a branch or +pull request associated with that issue, following the contribution model you define in a +[configuration file](#configuration). ![Create PR](docs/images/create-pr.svg) @@ -47,10 +52,6 @@ To **remove** this extension just run: gh extension remove sherpa ``` -## Usage - -After installing this extension in your development environment, you can know the available commands in the [`USAGE.md`](docs/USAGE.md) file. - ## Configuration Check the [`internal/config/default-config.yml`](internal/config/default-config.yml) file to see the available configuration parameters as well as the default values and some examples. @@ -60,6 +61,10 @@ In order to override the default values, you can use your own configuration file If no configuration file is found, the first time you run a command it will ask you to configure your Jira credentials (if you want to use Jira integration) and then proceed to create the configuration file with the provided Jira credentials. +## Usage + +After installing this extension in your development environment, you can know the available commands in the [`USAGE.md`](docs/USAGE.md) file. + ## Contribute Before developing any new feature or fix, please, check the [`CONTRIBUTING.md`](CONTRIBUTING.md) file. You will find there the steps to contribute along with development and testing guidelines. From e0a1eea895e7f686195c0b79a25da96c649ae06a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jorge=20Garc=C3=ADa=20Rey?= Date: Tue, 19 Dec 2023 17:00:42 +0100 Subject: [PATCH 2/3] docs: improve readme MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jorge García Rey --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index efda69e..464d4d8 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ # Sherpa extension for GitHub CLI -**Sherpa** for [GitHub CLI](https://github.com/cli/cli) makes it easy for you to **create branches** and **pull requests** +Sherpa for [GitHub CLI](https://github.com/cli/cli) makes it easy for you to **create branches** and **pull requests** associated with any **GitHub or Jira issue**. This extension retrieves the type of issue (_User Story_, _Bug_, _Technical Improvement_ etc) and creates a branch or From 7b69d409b8994d715aa5f2a0d61d4786e6596f0e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jorge=20Garc=C3=ADa=20Rey?= Date: Tue, 19 Dec 2023 17:02:30 +0100 Subject: [PATCH 3/3] docs: improve readme MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jorge García Rey --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 464d4d8..ecb87ec 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ pull request associated with that issue, following the contribution model you de - [Prerequisites](#prerequisites) - [Installation](#installation) -- [Usage](#usage) - [Configuration](#configuration) +- [Usage](#usage) - [Contribute](#contribute) ## Prerequisites