Skip to content

Commit

Permalink
Merge pull request #347 from IlyaPechersky/enumerate-steps
Browse files Browse the repository at this point in the history
Add the specific contribution steps in order in the README
  • Loading branch information
yegor256 committed May 28, 2024
2 parents 3e8c8f0 + 9bfc410 commit b5d3e14
Showing 1 changed file with 25 additions and 24 deletions.
49 changes: 25 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,37 +109,38 @@ 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.
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):

```bash
sudo make install
sudo make test lint
```
```bash
sudo make install
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:

You can also test it with Docker:
```bash
docker build . -t cam
docker run --rm cam make test
```

```bash
docker build . -t cam
docker run --rm cam make test
```
There is even a faster way to run all tests, with the help of Docker,
if you don't change any installation scripts:

There is even a faster way to run all tests, with the help of Docker,
if you don't change any installation scripts:
```bash
docker run -v $(pwd):/c --rm yegor256/cam:0.9.2 make -C /c test
```

```bash
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).
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

Expand Down

0 comments on commit b5d3e14

Please sign in to comment.