Skip to content

Commit 2cfc92c

Browse files
piotrostrpiotrostr
authored
lint CONTRIBUTING.md and README.md (#1123)
1 parent 56b4e2b commit 2cfc92c

File tree

2 files changed

+37
-38
lines changed

2 files changed

+37
-38
lines changed

‎CONTRIBUTING.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ you to accept the CLA when you open your pull request.
1616

1717
[Fork][fork], then clone the repository:
1818

19-
```
19+
```bash
2020
mkdir -p $GOPATH/src/go.uber.org
2121
cd $GOPATH/src/go.uber.org
2222
git clone [email protected]:your_github_username/zap.git
@@ -27,7 +27,7 @@ git fetch upstream
2727

2828
Make sure that the tests and the linters pass:
2929

30-
```
30+
```bash
3131
make test
3232
make lint
3333
```
@@ -36,7 +36,7 @@ make lint
3636

3737
Start by creating a new branch for your changes:
3838

39-
```
39+
```bash
4040
cd $GOPATH/src/go.uber.org/zap
4141
git checkout master
4242
git fetch upstream
@@ -47,22 +47,22 @@ git checkout -b cool_new_feature
4747
Make your changes, then ensure that `make lint` and `make test` still pass. If
4848
you're satisfied with your changes, push them to your fork.
4949

50-
```
50+
```bash
5151
git push origin cool_new_feature
5252
```
5353

5454
Then use the GitHub UI to open a pull request.
5555

56-
At this point, you're waiting on us to review your changes. We *try* to respond
56+
At this point, you're waiting on us to review your changes. We _try_ to respond
5757
to issues and pull requests within a few business days, and we may suggest some
5858
improvements or alternatives. Once your changes are approved, one of the
5959
project maintainers will merge them.
6060

6161
We're much more likely to approve your changes if you:
6262

63-
* Add tests for new functionality.
64-
* Write a [good commit message][commit-message].
65-
* Maintain backward compatibility.
63+
- Add tests for new functionality.
64+
- Write a [good commit message][commit-message].
65+
- Maintain backward compatibility.
6666

6767
[fork]: https://github.com/uber-go/zap/fork
6868
[open-issue]: https://github.com/uber-go/zap/issues/new

‎README.md

+29-30
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ and make many small allocations. Put differently, using `encoding/json` and
5454
Zap takes a different approach. It includes a reflection-free, zero-allocation
5555
JSON encoder, and the base `Logger` strives to avoid serialization overhead
5656
and allocations wherever possible. By building the high-level `SugaredLogger`
57-
on that foundation, zap lets users *choose* when they need to count every
57+
on that foundation, zap lets users _choose_ when they need to count every
5858
allocation and when they'd prefer a more familiar, loosely typed API.
5959

6060
As measured by its own [benchmarking suite][], not only is zap more performant
@@ -64,40 +64,40 @@ id="anchor-versions">[1](#footnote-versions)</sup>
6464

6565
Log a message and 10 fields:
6666

67-
| Package | Time | Time % to zap | Objects Allocated |
68-
| :------ | :--: | :-----------: | :---------------: |
69-
| :zap: zap | 2900 ns/op | +0% | 5 allocs/op
70-
| :zap: zap (sugared) | 3475 ns/op | +20% | 10 allocs/op
71-
| zerolog | 10639 ns/op | +267% | 32 allocs/op
72-
| go-kit | 14434 ns/op | +398% | 59 allocs/op
73-
| logrus | 17104 ns/op | +490% | 81 allocs/op
74-
| apex/log | 32424 ns/op | +1018% | 66 allocs/op
75-
| log15 | 33579 ns/op | +1058% | 76 allocs/op
67+
| Package | Time | Time % to zap | Objects Allocated |
68+
| :------------------ | :---------: | :-----------: | :---------------: |
69+
| :zap: zap | 2900 ns/op | +0% | 5 allocs/op |
70+
| :zap: zap (sugared) | 3475 ns/op | +20% | 10 allocs/op |
71+
| zerolog | 10639 ns/op | +267% | 32 allocs/op |
72+
| go-kit | 14434 ns/op | +398% | 59 allocs/op |
73+
| logrus | 17104 ns/op | +490% | 81 allocs/op |
74+
| apex/log | 32424 ns/op | +1018% | 66 allocs/op |
75+
| log15 | 33579 ns/op | +1058% | 76 allocs/op |
7676

7777
Log a message with a logger that already has 10 fields of context:
7878

79-
| Package | Time | Time % to zap | Objects Allocated |
80-
| :------ | :--: | :-----------: | :---------------: |
81-
| :zap: zap | 373 ns/op | +0% | 0 allocs/op
82-
| :zap: zap (sugared) | 452 ns/op | +21% | 1 allocs/op
83-
| zerolog | 288 ns/op | -23% | 0 allocs/op
84-
| go-kit | 11785 ns/op | +3060% | 58 allocs/op
85-
| logrus | 19629 ns/op | +5162% | 70 allocs/op
86-
| log15 | 21866 ns/op | +5762% | 72 allocs/op
87-
| apex/log | 30890 ns/op | +8182% | 55 allocs/op
79+
| Package | Time | Time % to zap | Objects Allocated |
80+
| :------------------ | :---------: | :-----------: | :---------------: |
81+
| :zap: zap | 373 ns/op | +0% | 0 allocs/op |
82+
| :zap: zap (sugared) | 452 ns/op | +21% | 1 allocs/op |
83+
| zerolog | 288 ns/op | -23% | 0 allocs/op |
84+
| go-kit | 11785 ns/op | +3060% | 58 allocs/op |
85+
| logrus | 19629 ns/op | +5162% | 70 allocs/op |
86+
| log15 | 21866 ns/op | +5762% | 72 allocs/op |
87+
| apex/log | 30890 ns/op | +8182% | 55 allocs/op |
8888

8989
Log a static string, without any context or `printf`-style templating:
9090

91-
| Package | Time | Time % to zap | Objects Allocated |
92-
| :------ | :--: | :-----------: | :---------------: |
93-
| :zap: zap | 381 ns/op | +0% | 0 allocs/op
94-
| :zap: zap (sugared) | 410 ns/op | +8% | 1 allocs/op
95-
| zerolog | 369 ns/op | -3% | 0 allocs/op
96-
| standard library | 385 ns/op | +1% | 2 allocs/op
97-
| go-kit | 606 ns/op | +59% | 11 allocs/op
98-
| logrus | 1730 ns/op | +354% | 25 allocs/op
99-
| apex/log | 1998 ns/op | +424% | 7 allocs/op
100-
| log15 | 4546 ns/op | +1093% | 22 allocs/op
91+
| Package | Time | Time % to zap | Objects Allocated |
92+
| :------------------ | :--------: | :-----------: | :---------------: |
93+
| :zap: zap | 381 ns/op | +0% | 0 allocs/op |
94+
| :zap: zap (sugared) | 410 ns/op | +8% | 1 allocs/op |
95+
| zerolog | 369 ns/op | -3% | 0 allocs/op |
96+
| standard library | 385 ns/op | +1% | 2 allocs/op |
97+
| go-kit | 606 ns/op | +59% | 11 allocs/op |
98+
| logrus | 1730 ns/op | +354% | 25 allocs/op |
99+
| apex/log | 1998 ns/op | +424% | 7 allocs/op |
100+
| log15 | 4546 ns/op | +1093% | 22 allocs/op |
101101

102102
## Development Status: Stable
103103

@@ -131,4 +131,3 @@ pinned in the [benchmarks/go.mod][] file. [↩](#anchor-versions)
131131
[cov]: https://codecov.io/gh/uber-go/zap
132132
[benchmarking suite]: https://github.com/uber-go/zap/tree/master/benchmarks
133133
[benchmarks/go.mod]: https://github.com/uber-go/zap/blob/master/benchmarks/go.mod
134-

0 commit comments

Comments
 (0)