Prepare for release candidate v1.0.0-rc.1

Signed-off-by: hoangtungdinh <[email protected]>

README.md

@@ -5,6 +5,8 @@ This project implements the [OTX Checker Bundle](checker_bundle_doc.md) for the
 The ASAM Quality Checker OTX library contains a short representative list of check examples for [Open Test sequence eXchange (OTX)](https://report.asam.net/otx-iso-13209-open-test-sequence-exchange-format)
 to showcase the functionality and implementation (it shall not be a reference implementation) for the ASAM Quality Checker project. 
 
+**Disclaimer**: The current version is a release candidate. The first official release is expected to be in November.
+
 - [asam-qc-otx](#asam-qc-otx)
   - [Installation and usage](#installation-and-usage)
     - [Installation using pip](#installation-using-pip)
@@ -184,3 +186,34 @@ You need to have pre-commit installed and install the hooks:
 ```
 pre-commit install
 ```
+
+**To implement a new checker:**
+
+1. Create a new Python module for each checker.
+2. Specify the following global variables for the Python module
+
+| Variable | Meaning |
+| --- | --- |
+| `CHECKER_ID` | The ID of the checker |
+| `CHECKER_DESCRIPTION` | The description of the checker |
+| `CHECKER_PRECONDITIONS` | A set of other checkers in which if any of them raise an issue, the current checker will be skipped |
+| `RULE_UID` | The rule UID of the rule that the checker will check |
+
+3. Implement the checker logic in the following function:
+
+```python
+def check_rule(checker_data: models.CheckerData) -> None:
+    pass
+```
+
+4. Register the checker module in the following function in [main.py](qc_otx/main.py).
+
+```python
+def run_checks(config: Configuration, result: Result) -> None:
+    ...
+    # Add the following line to register your checker module
+    execute_checker(your_checker_module, checker_data)
+    ...
+```
+
+All the checkers in this checker bundle are implemented in this way. Take a look at some of them before implementing your first checker.

checker_bundle_doc.md

@@ -1,11 +1,12 @@
 # Checker bundle: otxBundle
 
-* Build version:  0.1.0
+* Build version:  v1.0.0-rc.1
 * Description:    OTX checker bundle
 
 ## Parameters
 
 * InputFile 
+* resultFile 
 
 ## Checkers
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "asam-qc-otx"
-version = "0.1.0"
+version = "1.0.0rc1"
 description = "This project implements the Open Test sequence eXchange Checker for the ASAM Quality Checker project."
 authors = ["Danilo Romano <[email protected]>"]
 license = "MPL-2.0"

qc_otx/constants.py

@@ -1,2 +1,2 @@
 BUNDLE_NAME = "otxBundle"
-BUNDLE_VERSION = "0.1.0"
+BUNDLE_VERSION = "v1.0.0-rc.1"

qc_otx/main.py

@@ -203,7 +203,6 @@ def main():
     result = Result()
     result.register_checker_bundle(
         name=constants.BUNDLE_NAME,
-        build_date=datetime.today().strftime("%Y-%m-%d"),
         description="OTX checker bundle",
         version=constants.BUNDLE_VERSION,
         summary="",