Skip to content

Commit 55d0301

Browse files
lint: add empty gherkin rules file
1 parent 2d8184a commit 55d0301

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

.gherkin-lintrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

contributing.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,25 @@ you can also use the formatter of the
148148

149149
To install yamllint follow the [instructions outlined here](https://github.com/adrienverge/yamllint/blob/master/docs/quickstart.rst#installing-yamllint).
150150

151+
### Gherkin style
152+
153+
Gherkin files should be appropriately formatted before a pull request is sent out.
154+
In this repository, we follow the
155+
[gherkin-lint rules](https://github.com/gherkin-lint/gherkin-lint?tab=readme-ov-file#available-rules).
156+
See [gherkin-lint](.gherkin-lintrc) for details.
157+
158+
We highly encourage using line breaks in markdown files at `80` characters
159+
wide. Some tools can do it for you effectively. Please submit the proposal
160+
to include your editor settings required to enable this behavior so the
161+
out-of-the-box settings for this repository will be consistent.
162+
163+
To install gherkin-lint run:
164+
165+
```bash
166+
npm install -g gherkin-lint
167+
gherkin-lint **/*.feature
168+
```
169+
151170
### Typos
152171

153172
In addition, please make sure to clean up typos before you submit the change.

0 commit comments

Comments
 (0)