Skip to content

Commit 169716f

Browse files
Apply suggestions from code review
Co-authored-by: Craig Norris <[email protected]> Signed-off-by: Alexa Kreizinger <[email protected]>
1 parent 61429a4 commit 169716f

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,32 @@
33

44
# Contributing to Fluent Bit docs
55

6-
First of all, thanks for taking the time to read this guide. The fact that you're here means you're interested in contributing to Fluent Bit, and we highly appreciate your time.
6+
First of all, thanks for taking the time to read this guide. The fact that you're here means you're interested in contributing to Fluent Bit, and we greatly appreciate your time.
77

88
This repository contains the files for the [Fluent Bit documentation library](https://docs.fluentbit.io/). Keeping these docs separate from the [main Fluent Bit repository](https://github.com/fluent/fluent-bit) helps reduce the number of commits to the Fluent Bit source code and makes it easier to maintain both projects.
99

10-
Fluent Bit has a group of dedicated maintainers who oversee this repository, including several technical writers. These writers will review any pull requests you open, so don't be afraid to contributeeven if you're not a writer by trade. Your suggestions are valuable, and we'll help you wrangle any stray commas.
10+
Fluent Bit has a group of dedicated maintainers who oversee this repository, including several technical writers. These writers will review any pull requests you open, so don't be afraid to contribute, even if you're not a writer by trade. Your suggestions are valuable, and we'll help you wrangle any stray commas.
1111

1212
## :star: Quick tips
1313

14+
Before you contribute to the Fluent Bit docs, review these critical tips:
15+
1416
- [Sign off](#sign-off-your-git-commits) your Git commits.
1517
- Use [soft line wraps](#line-wraps) in Markdown files.
1618
- To link between pages, use [absolute file paths](#links).
1719
- Review the results of [linters](#linters) for style and formatting guidance.
1820

1921
## Review process
2022

21-
After you open a pull request in this repository, a Fluent Bit maintainer will review it, add comments or suggestions as needed, and then merge it. After your changes are successfully merges into `master`, the docs site will update within a few minutes.
23+
After you open a pull request in this repository, a Fluent Bit maintainer will review it, add comments or suggestions as needed, and then merge it. After your changes are successfully merged into `master`, the docs site will update within a few minutes.
2224

2325
### Request review without merging
2426

2527
If you're contributing documentation for a Fluent Bit feature that's still in development, ask a maintainer to add the `waiting-on-code-merge` label to your pull request. This lets other maintainers know that your changes aren't ready to merge yet, even if they were approved.
2628

2729
### Stale pull requests
2830

29-
If you open a pull request that requires extended discussion or review, the Fluent Bit maintainers will add a `waiting-for-user` label to your pull request. This label means that we're blocked from moving forward until you reply. To keep contributions from going stale, we'll wait 45 days for your response, but we might close the pull request if we don't hear back from you by then.
31+
If you open a pull request that requires extended discussion or review, the Fluent Bit maintainers will add a `waiting-for-user` label to your pull request. This label means that we're blocked from moving forward until you reply. To keep contributions from going stale, we'll wait 45 days for your response, after which we might close the pull request if we don't hear back from you.
3032

3133
## Pass DCO checks
3234

@@ -40,7 +42,7 @@ For more information, refer to GitHub's guide to [setting your commit email addr
4042

4143
### Sign off your Git commits
4244

43-
You must sign off your commits to certify your identity as the commit author. A commit is "signed off" when its commit message looks like this:
45+
You must sign off your commits to certify your identity as the commit author. A commit is signed off when its commit message looks like this:
4446

4547
```text
4648
pipeline: outputs: syslog: fix grammar in examples
@@ -51,16 +53,15 @@ For faster signing, you can use the `-s` flag:
5153

5254
`git commit -a -s -m "pipeline: outputs: syslog: fix grammar in examples"`
5355

54-
> :bulb: If you're using VSCode, the [**Git: Always Sign Off**](https://github.com/microsoft/vscode/issues/83096#issuecomment-545350047) option automatically appends a `Signed-off-by:` message to all of your commits.
56+
> :bulb: If you're using VSCode, the [**Git: Always Sign Off**](https://github.com/microsoft/vscode/issues/83096#issuecomment-545350047) option appends a `Signed-off-by:` message to all of your commits.
5557
5658
### Fix "DCO is missing" errors
5759

5860
If a DCO error blocks your pull request from merging, refer to this guide about [how to add sign-offs retroactively](https://github.com/src-d/guide/blob/master/developer-community/fix-DCO.md#how-to-add-sign-offs-retroactively).
5961

6062
## Style guidelines
6163

62-
The Fluent Bit documentation follows the [Google developer documentation style guide](https://developers.google.com/style) for most topics related to grammar and style. We don't expect you
63-
to memorize these style rules, but the maintainers who review your pull request might suggest changes accordingly.
64+
The Fluent Bit documentation follows the [Google developer documentation style guide](https://developers.google.com/style) for most topics related to grammar and style. We don't expect you to memorize these style rules, but the maintainers who review your pull request might suggest changes accordingly.
6465

6566
The active [linters](#linters) in this repository flag certain style errors and, in some cases, explain how to fix them.
6667

@@ -70,8 +71,7 @@ The Fluent Bit docs library is built and hosted through [GitBook](https://docs.g
7071

7172
### Links
7273

73-
When cross-linking between in this repository, use a full absolute path whenever
74-
possible. For example:
74+
When cross-linking between in this repository, use a full absolute path whenever possible. For example:
7575

7676
```text
7777
[LTSV](../pipeline/parsers/ltsv.md) and [Logfmt](../pipeline/parsers/logfmt.md)
@@ -117,7 +117,7 @@ curly quotes. If you copy-paste from one of these tools, you must correct the qu
117117

118118
When you create a new `.md` file for a new page, you must add an entry to this repository's [`SUMMARY.md` file](https://github.com/fluent/fluent-bit-docs/blob/master/SUMMARY.md) (or ask a maintainer to add it on your behalf). If you don't update `SUMMARY.md`, the new page won't appear in the table of contents on the Fluent Bit docs site.
119119

120-
Similarly, if you update the `# h1` title header of an existing page, make sure to update that page's `SUMMARY.md` entry to match. `SUMMARY.md` entries takes precedence over in-page headers, which means that if you update a page's `# h1` title without updating `SUMMARY.md`, the unchanged `SUMMARY.md` title will persist in both the rendered page and the table of contents.
120+
Similarly, if you update the `# h1` title header of an existing page, be sure to update that page's `SUMMARY.md` entry to match. `SUMMARY.md` entries takes precedence over in-page headers, which means that if you update a page's `# h1` title without updating `SUMMARY.md`, the unchanged `SUMMARY.md` title will persist in both the rendered page and the table of contents.
121121

122122
## Linters
123123

0 commit comments

Comments
 (0)