Skip to content

Commit 28be9a0

Browse files
authored
Typo fixes in readme and contributing.md (#588)
fixes #576
1 parent a5cd893 commit 28be9a0

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ If you want to help me here, great! Thank you! Some ideas:
2424
place to start.
2525

2626
- [Once I've made a once over
27-
triaging](https://github.com/trentm/node-bunyan/issues/335) and consolodating
27+
triaging](https://github.com/trentm/node-bunyan/issues/335) and consolidating
2828
issues and PRs, volunteering for issues in a particular
2929
[component](#component) with which you have familiarity would be great.
3030

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -423,7 +423,7 @@ rules and best practices for serializer functions:
423423
- A serializer function *should never throw*. The bunyan library *does*
424424
protect somewhat from this: if the serializer throws an error, then
425425
bunyan will (a) write an ugly message on stderr (along with the traceback),
426-
and (b) the field in the log record will be replace with a short error message.
426+
and (b) the field in the log record will be replaced with a short error message.
427427
For example:
428428

429429
```
@@ -445,7 +445,7 @@ rules and best practices for serializer functions:
445445
- A serializer function *should never mutate the given object*. Doing so will
446446
change the object in your application.
447447
448-
- A serializer function *should be defensive*. In my experience it is common to
448+
- A serializer function *should be defensive*. In my experience, it is common to
449449
set a serializer in an app, say for field name "foo", and then accidentally
450450
have a log line that passes a "foo" that is undefined, or null, or of some
451451
unexpected type. A good start at defensiveness is to start with this:
@@ -655,7 +655,7 @@ Pretty-printed:
655655
is the name of the service/app using Bunyan for logging.
656656
- `hostname`: Required. String. Provided or determined at Logger creation.
657657
You can specify your hostname at Logger creation or it will be retrieved
658-
vi `os.hostname()`.
658+
via `os.hostname()`.
659659
- `pid`: Required. Integer. Filled in automatically at Logger creation.
660660
- `time`: Required. String. Added by Bunyan. Can be overridden.
661661
The date and time of the event in [ISO 8601
@@ -732,7 +732,7 @@ follow (feedback from actual users welcome).
732732
- `req.username`: Authenticated user (or for a 401, the user attempting to
733733
auth).
734734
- Some mechanism to calculate response latency. "restify" users will have
735-
a "X-Response-Time" header. A `latency` custom field would be fine.
735+
an "X-Response-Time" header. A `latency` custom field would be fine.
736736
- `req.body`: If you know that request bodies are small (common in APIs,
737737
for example), then logging the request body is good.
738738

@@ -1066,7 +1066,7 @@ used for anything else.</td>
10661066

10671067
**Note on log rotation**: Often you may be using external log rotation utilities
10681068
like `logrotate` on Linux or `logadm` on SmartOS/Illumos. In those cases, unless
1069-
your are ensuring "copy and truncate" semantics (via `copytruncate` with
1069+
you are ensuring "copy and truncate" semantics (via `copytruncate` with
10701070
logrotate or `-c` with logadm) then the fd for your 'file' stream will change.
10711071
You can tell bunyan to reopen the file stream with code like this in your
10721072
app:

0 commit comments

Comments
 (0)