Skip to content

Use GitHub's alert syntax #1234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 15, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,12 @@ CSharp: # required, this will be the name of the enum variant for the language a
serialization: c# # required only if the Enum name `CSharp` doesn't match the display name `C#`
```

_**NOTE**: An additional field, `line_types` can also be set on a language's attributes. It has been excluded because_
_it is not necessary for the majority of languages. By default, only a language's lines of code are counted, but this_
_field can be used to count other lines, too. For example, `line_types: [code, comments]`. This is useful in languages_
_like Markdown, where the significant lines are mostly comments. A list of available fields to be used can be found in_
_[tokei's documentation](https://docs.rs/tokei/latest/tokei/struct.Language.html#fields)._
> [!NOTE]
> An additional field, `line_types` can also be set on a language's attributes. It has been excluded because
> it is not necessary for the majority of languages. By default, only a language's lines of code are counted, but this
> field can be used to count other lines, too. For example, `line_types: [code, comments]`. This is useful in languages
> like Markdown, where the significant lines are mostly comments. A list of available fields to be used can be found in
> [tokei's documentation](https://docs.rs/tokei/latest/tokei/struct.Language.html#fields).

- link 1: https://github.com/XAMPPRocky/tokei#supported-languages
- link 2: https://github.com/github/linguist/blob/master/lib/linguist/languages.yml
Expand Down