Skip to content

Commit

Permalink
contrib: adding suggestion for URLs and updating vale info
Browse files Browse the repository at this point in the history
Signed-off-by: Lynette Miles <[email protected]>
  • Loading branch information
esmerel committed Nov 5, 2024
1 parent 197ba68 commit 8cd5fbd
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ the docs library. If you create a new page, you'll also need to update

## Workflow

After you open a pull request in this repo, a Fluent Bit maintainer will review
After you open a pull request in this repository, a Fluent Bit maintainer will review
it, triage 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.
Expand Down Expand Up @@ -99,9 +99,9 @@ To prevent DCO errors, refer to the following guide about
>
> `git commit -a -s -m "pipeline: outputs: syslog: fix grammar in examples"`
>
> If you're using VS Code, you can also enable the
> If you're using VSCode, you can also enable the
> [**Git: Always Sign Off**](https://github.com/microsoft/vscode/issues/83096#issuecomment-545350047)
> setting, whch automatically appends a `Signed-off-by:` message to your commits.
> setting, which automatically appends a `Signed-off-by:` message to your commits.
## Style guidelines

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

### URLs

When cross-linking to a page in this repository, use a full relative path whenever
possible. For example:

```text
[LTSV](pipeline/parsers/ltsv.md) and [Logfmt](pipeline/parsers/logfmt.md)
```

### Vale

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

0 comments on commit 8cd5fbd

Please sign in to comment.