Skip to content

Commit

Permalink
fix markdown style
Browse files Browse the repository at this point in the history
  • Loading branch information
timur-harin committed May 19, 2024
1 parent a3ca993 commit 8873713
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,21 +109,25 @@ make REPO=yegor256/tojos

## How to Contribute (e.g. by adding a new metric)


If you want to add a new metric to the script, follow these steps:

1. Fork the repository.
2. Create a new file in the `metrics/` directory, using one of the existing files as an example.
2. Create a new file in the `metrics/` directory,

Check failure on line 115 in README.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Trailing spaces [Expected: 0 or 2; Actual: 1]
using one of the existing files as an example.
3. Implement the logic for your new metric in the newly created file.
4. Create a test for your metric in the `tests/metrics/` directory.
5. Run the entire test suite to ensure that your metric passes all the existing tests and is working as expected. To do this, run the following commands:
5. Run the entire test suite to ensure

Check failure on line 119 in README.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Trailing spaces [Expected: 0 or 2; Actual: 1]
that your metric passes all the existing

Check failure on line 120 in README.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Trailing spaces [Expected: 0 or 2; Actual: 1]
tests and is working as expected.

Check failure on line 121 in README.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Trailing spaces [Expected: 0 or 2; Actual: 1]
To do this, run the following commands:

```bash
sudo make install
make test lint
```

- If you need to install packages on macOS using Homebrew, you can run the following command:
If you need to install packages on macOS using Homebrew,

Check failure on line 129 in README.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Trailing spaces [Expected: 0 or 2; Actual: 1]
you can run the following command:

```bash
cat brew-requirements.txt | xargs brew install
Expand All @@ -134,7 +138,6 @@ cat brew-requirements.txt | xargs brew install
We will review your changes and apply them to the `master` branch shortly,
provided they don't violate our quality standards.

<br></br>

Check failure on line 141 in README.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Multiple consecutive blank lines [Expected: 1; Actual: 2]
You can also test it with Docker:

Expand Down

0 comments on commit 8873713

Please sign in to comment.