Skip to content

Commit 17a825f

Browse files
committed
Add a note about contributing in the README.md.
1 parent b83957b commit 17a825f

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,12 @@ Trait (MAJOR)
134134
Time: 1.43 seconds, Memory: 5.123 MB
135135
```
136136

137+
## Contributing
138+
### Adding new rules
139+
* Add the rules to the `docs/Ruleset.md` document
140+
* Run `php scripts/extract-rules-from-ruleset.php` to generate an up to date array to paste in the `Configuration/LevelMapping.php` file
141+
* Update the documentation @ https://github.com/tomzx/php-semver-checker-docs
142+
137143
## License
138144

139145
The code is licensed under the [MIT license](http://choosealicense.com/licenses/mit/). See [LICENSE](LICENSE).

0 commit comments

Comments
 (0)