Skip to content

Commit 455dc13

Browse files
Merge pull request #173 from MikeMcC399/move/contributing
docs: move README contributing section to CONTRIBUTING.md
2 parents 72b5124 + 6d17980 commit 455dc13

File tree

2 files changed

+18
-13
lines changed

2 files changed

+18
-13
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Contributing to cypress-io/eslint-plugin-cypress
2+
3+
Thanks for taking the time to contribute! :smile:
4+
5+
To add a new rule:
6+
* Fork and clone this repository
7+
* Generate a new rule (a [yeoman generator](https://github.com/eslint/generator-eslint) is available)
8+
* Run `yarn start` or `npm start`
9+
* Write test scenarios then implement logic
10+
* Describe the rule in the generated `docs` file
11+
* Make sure all tests are passing
12+
* Add the rule to the [README](README.md) file
13+
* Create a PR
14+
15+
Use the following commit message conventions: https://github.com/semantic-release/semantic-release#commit-message-format

README.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -159,16 +159,6 @@ Or you can simply add its `recommended` config:
159159
}
160160
```
161161

162-
## Contribution Guide
163-
164-
To add a new rule:
165-
* Fork and clone this repository
166-
* Generate a new rule (a [yeoman generator](https://github.com/eslint/generator-eslint) is available)
167-
* Run `yarn start` or `npm start`
168-
* Write test scenarios then implement logic
169-
* Describe the rule in the generated `docs` file
170-
* Make sure all tests are passing
171-
* Add the rule to this README
172-
* Create a PR
173-
174-
Use the following commit message conventions: https://github.com/semantic-release/semantic-release#commit-message-format
162+
## Contributing
163+
164+
Please see our [Contributing Guideline](./CONTRIBUTING.md) which explains how to contribute rules or other fixes and features to the repo.

0 commit comments

Comments
 (0)