Skip to content

Commit

Permalink
add steps order in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
IlyaPechersky committed May 27, 2024
1 parent b621604 commit 97bf897
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,24 +109,18 @@ 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, fork a repository and
create a new file in the `metrics/` directory, using one of
the existing files as an example.
Then, create a test for your metric, in the `tests/metrics/` directory.
For example, you want to add a new metric to the script:

Then, run the entire test suite
(this should take a few minutes to complete, without errors):
1. Fork a repository.
2. Create a new file in the `metrics/` directory, using one of the existing files as an example.

Check failure on line 115 in README.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length [Expected: 80; Actual: 96]
3. Create a test for your metric, in the `tests/metrics/` directory.
4. Run the entire test suite (this should take a few minutes to complete, without errors):

Check failure on line 117 in README.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length [Expected: 80; Actual: 90]

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

Then, send us a
[pull request](https://www.yegor256.com/2014/04/15/github-guidelines.html).
We will review your changes and apply them to the `master` branch shortly,
provided they don't violate our quality standards.

You can also test it with Docker:

```bash
Expand All @@ -141,6 +135,10 @@ if you don't change any installation scripts:
docker run -v $(pwd):/c --rm yegor256/cam:0.9.2 make -C /c test
```

5. Send us a [pull request](https://www.yegor256.com/2014/04/15/github-guidelines.html).

Check failure on line 138 in README.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Trailing spaces [Expected: 0 or 2; Actual: 1]

Check failure on line 138 in README.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length [Expected: 80; Actual: 89]

Check failure on line 138 in README.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Ordered list item prefix [Expected: 1; Actual: 5; Style: 1/1/1]
We will review your changes and apply them to the `master` branch shortly,
provided they don't violate our quality standards.

## How to Calculate Additional Metrics

You may want to use this dataset as a basis, with an intend of adding your own
Expand Down

0 comments on commit 97bf897

Please sign in to comment.