Skip to content

Commit

Permalink
docs: add security section in README
Browse files Browse the repository at this point in the history
Signed-off-by: Jorge García Rey <[email protected]>
  • Loading branch information
jorgegarciarey committed Jan 22, 2024
1 parent 85a0673 commit 56c8cc2
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 11 deletions.
32 changes: 22 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
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
pull request associated with that issue, following the contribution model you define in a
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)
Expand All @@ -23,8 +23,10 @@ pull request associated with that issue, following the contribution model you de
## Prerequisites

- An available GitHub account.
- [**GitHub CLI**](https://github.com/cli/cli) (version `2.0.0` or higher) configured and [authenticated](https://cli.github.com/manual/gh_auth_login) in your development environment.
- **Bash**: Supports Linux, MacOS and Windows (for the latter, we recommend using [`WSL2`](https://learn.microsoft.com/en-us/windows/wsl/install)).
- [**GitHub CLI**](https://github.com/cli/cli) (version `2.0.0` or higher) configured and
[authenticated](https://cli.github.com/manual/gh_auth_login) in your development environment.
- **Bash**: Supports Linux, MacOS and Windows (for the latter, we recommend using
[`WSL2`](https://learn.microsoft.com/en-us/windows/wsl/install)).

## Installation

Expand All @@ -38,7 +40,8 @@ gh extension install InditexTech/gh-sherpa

### Upgrade

If you have already installed this extension and you want to **upgrade** it, so, you should run this command from your terminal:
If you have already installed this extension and you want to **upgrade** it, so, you should run this command from your
terminal:

```sh
gh extension upgrade sherpa
Expand All @@ -64,15 +67,24 @@ file to perform these mappings.

### Custom configuration

Otherwise, if you wish customize the different issue types, branch prefixes, etc, so, you can **create your own configuration
file** localed in `$HOME/.config/sherpa/config.yml` from the [default config file](internal/config/default-config.yml).
Otherwise, if you wish customize the different issue types, branch prefixes, etc, so, you can **create your own
configuration file** localed in `$HOME/.config/sherpa/config.yml` from the
[default config file](internal/config/default-config.yml).

> If you are **using Jira as issue tracker**, so, the first time you run a command it will ask you to configure Jira credentials and then proceed to create the custom configuration file with the provided Jira credentials.
> If you are **using Jira as issue tracker**, so, the first time you run a command it will ask you to configure Jira
credentials and then proceed to create the custom 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.
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.
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.

## Security

If you find a security vulnerability in this project, please, check the [`SECURITY.md`](SECURITY.md) file to know how to
report it.
2 changes: 1 addition & 1 deletion repolinter.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
}
},
"security-file-exists": {
"level": "off",
"level": "error",
"rule": {
"type": "file-existence",
"options": {
Expand Down

0 comments on commit 56c8cc2

Please sign in to comment.