Skip to content

Commit

Permalink
Merge pull request #34 from coreruleset/update-dev-readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fzipi authored Oct 6, 2022
2 parents 75422c1 + 3ac2de4 commit db30017
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,15 @@ models = parser.process_rules(files)
parser.get_correctness(files, models)
```
## Development
If you want to modify this module, follow these steps:
1. Clone this repository: `git clone [email protected]:coreruleset/secrules_parsing.git`
1. Do not forget to install dependencies using [poetry](https://python-poetry.org/docs/): `poetry install` first!
1. Edit and change the files you want.
1. Write tests! Tests are in the `tests` subdirectory
1. Create a PR [here](https://github.com/coreruleset/secrules_parsing/compare), and ask for review!
## Misc
To visualize the syntax tree, use:
Expand Down

0 comments on commit db30017

Please sign in to comment.