Skip to content

Commit 5d8a650

Browse files
authored
contrib: adding suggestion for URLs and updating vale info (fluent#1502)
* contrib: adding suggestion for URLs and updating vale info Signed-off-by: Lynette Miles <[email protected]> * contrib: missed a save Signed-off-by: Lynette Miles <[email protected]> --------- Signed-off-by: Lynette Miles <[email protected]>
1 parent 197ba68 commit 5d8a650

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

CONTRIBUTING.md

+14-6
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ the docs library. If you create a new page, you'll also need to update
3232

3333
## Workflow
3434

35-
After you open a pull request in this repo, a Fluent Bit maintainer will review
35+
After you open a pull request in this repository, a Fluent Bit maintainer will review
3636
it, triage it, add comments or suggestions as needed, and then merge it. After
3737
your changes are successfully merged into `master`, the docs site will update
3838
within a few minutes.
@@ -99,9 +99,9 @@ To prevent DCO errors, refer to the following guide about
9999
>
100100
> `git commit -a -s -m "pipeline: outputs: syslog: fix grammar in examples"`
101101
>
102-
> If you're using VS Code, you can also enable the
102+
> If you're using VSCode, you can also enable the
103103
> [**Git: Always Sign Off**](https://github.com/microsoft/vscode/issues/83096#issuecomment-545350047)
104-
> setting, whch automatically appends a `Signed-off-by:` message to your commits.
104+
> setting, which automatically appends a `Signed-off-by:` message to your commits.
105105
106106
## Style guidelines
107107

@@ -111,8 +111,16 @@ for most topics related to grammar, style, and formatting. We don't expect you
111111
to memorize these style rules, but the technical writer who reviews your pull
112112
request may suggest changes accordingly.
113113

114+
### URLs
115+
116+
When cross-linking to a page in this repository, use a full relative path whenever
117+
possible. For example:
118+
119+
```text
120+
[LTSV](pipeline/parsers/ltsv.md) and [Logfmt](pipeline/parsers/logfmt.md)
121+
```
122+
114123
### Vale
115124

116-
The Fluent Bit maintainers are working to add a [Vale](https://vale.sh/docs/) plugin
117-
to this repository, which will automatically lint pull requests and add
118-
suggestions to improve style and clarity.
125+
The Fluent Bit maintainers use the [Vale](https://vale.sh/docs/) plugin, which lints
126+
pull requests and adds suggestions to improve style and clarity.

0 commit comments

Comments
 (0)