Skip to content

Commit

Permalink
Merge pull request #173 from MikeMcC399/move/contributing
Browse files Browse the repository at this point in the history
docs: move README contributing section to CONTRIBUTING.md
  • Loading branch information
jennifer-shehane committed Apr 17, 2024
2 parents 72b5124 + 6d17980 commit 455dc13
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 13 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Contributing to cypress-io/eslint-plugin-cypress

Thanks for taking the time to contribute! :smile:

To add a new rule:
* Fork and clone this repository
* Generate a new rule (a [yeoman generator](https://github.com/eslint/generator-eslint) is available)
* Run `yarn start` or `npm start`
* Write test scenarios then implement logic
* Describe the rule in the generated `docs` file
* Make sure all tests are passing
* Add the rule to the [README](README.md) file
* Create a PR

Use the following commit message conventions: https://github.com/semantic-release/semantic-release#commit-message-format
16 changes: 3 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,16 +159,6 @@ Or you can simply add its `recommended` config:
}
```

## Contribution Guide

To add a new rule:
* Fork and clone this repository
* Generate a new rule (a [yeoman generator](https://github.com/eslint/generator-eslint) is available)
* Run `yarn start` or `npm start`
* Write test scenarios then implement logic
* Describe the rule in the generated `docs` file
* Make sure all tests are passing
* Add the rule to this README
* Create a PR

Use the following commit message conventions: https://github.com/semantic-release/semantic-release#commit-message-format
## Contributing

Please see our [Contributing Guideline](./CONTRIBUTING.md) which explains how to contribute rules or other fixes and features to the repo.

0 comments on commit 455dc13

Please sign in to comment.