Skip to content

Commit

Permalink
README.md: Update documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Norbert Kamiński <[email protected]>
  • Loading branch information
Norbert Kamiński committed Aug 4, 2023
1 parent 1943835 commit 1093404
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,65 @@ additional layer of control and verification in the beta/prod environment.
> by rebasing you branch: `git rebase --onto <new-parent> <old-parent>`. For
> example: `git rebase --onto develop main`.
### Broken links checker

Currently we are using [lychee](https://github.com/lycheeverse/lychee) a fast,
async, stream-based link checker written in Rust. The automatic check is
triggered on each push to the master pull request.

You can also run it locally using a docker image:

```bash
$ docker run --init -it --rm -w $(pwd) -v $(pwd):$(pwd) lycheeverse/lychee
--max-redirects 10 -a 403,429,500,502,503,999 .
```

### Relative links

Please avoid using relative like:

```md
[contact](../../contact/)
```

Instead, use absolute links:

```md
[contact](https://3mdeb.com/contact/)
```

### pre-commit hooks

- [Install pre-commit](https://pre-commit.com/index.html#install), if you
followed [local build](#local-preview) procedure `pre-commit` should be
installed

- [Install go](https://go.dev/doc/install)

- Install hooks into repo:

```shell
pre-commit install --hook-type commit-msg
```

- Enjoy automatic checks on each `git commit` action!

- (Optional) Run hooks on all files (for example, when adding new hooks or
configuring existing ones):

```shell
pre-commit run --all-files
```

#### To skip verification

In some cases, it may be needed to skip `pre-commit` tests. To do that, please
use:

```shell
git commit --no-verify
```

### Grammarly - a must have for content verification

Grammarly is a great, free tool for all bloggers and anyone who needs to write
Expand Down

0 comments on commit 1093404

Please sign in to comment.