Improved documentation

Author: Koen1999

CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# Contributing
+
+If you would like to contribute, below you can find some helpful suggestions and instructions.
+
+## Preparing the development environment
+
+To install packages required for running tests and linting, run the following command:
+
+```bash
+pip install -U -r requirements.txt
+```
+
+## Running tests
+
+If you wish to run the majority of the tests whilst skipping the slow integration tests on large third-party rulesets, use the following command:
+
+```bash
+pytest
+```
+
+To run the slower integration tests at the end of your development cycle, use the following command instead:
+
+```bash
+pytest -m "slow" -k "not train"
+```
+
+## Linting
+
+To automatically fix some linting issues and check for remaining issues, run the following commands:
+
+```bash
+black .
+ruff check . --fix
+pyright
+```
+
+## Docs
+
+To automatically generate the documentation from the code, run the following commands:
+
+```bash
+./docs/make.bat clean
+./docs/make.bat html
+```
+
+To locally view the docs, run the following command:
+
+```bash
+python -m http.server -b localhost -d docs/_build/html 8000
+```
+
+and inspect the docs at `localhost:8000`

README.md

@@ -9,6 +9,14 @@
 [`suricata-check`](https://github.com/Koen1999/suricata-check) is a command line utility to provide feedback on [Suricata](https://github.com/OISF/suricata) rules.
 The tool can detect various issues including those covering syntax validity, interpretability, rule specificity, rule coverage, and efficiency.
 
+## How to use this template
+
+1. Choose a name for your extension (e.g. `suricata-check-foobar`) and replace `suricata-check-extension-example` by your chosen name in all folder names, file names, and file contents. Similarly, replace `suricata_check_extension_example` by your chosen name with the dashes (`-`) substituted by underscores (`_`).
+2. Rename `suricata_check_extension-example/checkers/example.py` and the class contained therein and make refactor accordingly in that file, and in `suricata_check_extension-example/checkers/init.py`.
+3. Similarly, rename `tests/checkers/test_example.py` and adjust the reference to the renamed checker file/class in that file and in `tests/test_suricata_check.py`.
+4. Implement tests for your checker in `tests/checkers/test_example.py` and implement the checker in `suricata_check_extension-example/checkers/example.py`.
+5. You can now package, distribute and install the extension like any other Python package. When installed, the extension will be automatically selected by `suricata-check` when ran from the command line.
+
 ## Contributing
 
 If you would like to contribute, please check out [CONTRIBUTING.md](https://github.com/Koen1999/suricata-check-extension-example/blob/master/CONTRIBUTING.md) some helpful suggestions and instructions.

pyproject.toml

@@ -44,6 +44,7 @@ classifiers = [
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: 3 :: Only",
   "Operating System :: OS Independent",
   "Operating System :: POSIX",