Skip to content

Commit

Permalink
Polish CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cyrus-and committed Aug 13, 2024
1 parent 27ef4b6 commit bd36c6c
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,11 +119,13 @@ Use the following placeholder values where appropriate:

### Multiline strings

If a multiline string is needed, use the `-` YAML literal variant, i.e., `|-`, for example:
If a multiline string is needed, use the `-` YAML literal variant to strip trailing newlines, i.e., `|-`, for example:

```
some-field: |-
Lorem ipsum...
Some
multiline
value
```

### Links
Expand All @@ -146,7 +148,7 @@ Before submitting any pull request, make sure the linter completes successfully:
make lint
```

Then use `make clean` to clean everything up.
Use `make clean` to clean everything up.

[YAML]: https://yaml.org/
[`_data/functions.yml`]: https://github.com/GTFOBins/GTFOBins.github.io/blob/master/_data/functions.yml
Expand Down

0 comments on commit bd36c6c

Please sign in to comment.