Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README with a detailed definition #26

Merged
merged 3 commits into from
Dec 19, 2023
Merged

Improve README with a detailed definition #26

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b454f17
docs: improve readme
jorgegarciarey Dec 19, 2023
e0a1eea
docs: improve readme
jorgegarciarey Dec 19, 2023
7b69d40
docs: improve readme
jorgegarciarey Dec 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
[![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)

## Table of contents

- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Configuration](#configuration)
- [Usage](#usage)
- [Contribute](#contribute)

## Prerequisites
Expand Down Expand Up @@ -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.
Expand All @@ -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.