Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Improve documentation for linting #267

Merged
merged 1 commit into from
Oct 28, 2024
Merged

Improve documentation for linting #267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,8 @@ CD in your Terminal to the root directory of the cloned repository. Install all
npm install
npm start
```

## Linting problems

The repository establishes commit hooks which check the files for correctness and style.
Have a look at the [linting-guide](https://docs.scs.community/community/contribute/linting-guide/) to get detailed information.
7 changes: 7 additions & 0 deletions community/contribute/linting-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,13 @@ The markdownlint rules are defined in the configuration file `.markdownlint-cli2

Additionally we use [markdownlint-rule-search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) for fixing

## Local Usage for development

```bash
npm run lint:md <file>
npm run fix:md <file>
```

## Github Workflows

There are two actions running on every Pull Request on the `main` branch.
Expand Down
Loading