Add guidelines for contributing and split requirements files.

.github/workflows/pytest.yml

@@ -36,8 +36,8 @@ jobs:
       - name: Install dependencies.
         run: |
           python -m pip install --upgrade pip
-          python -m pip install -r requirement.txt
-          python -m pip install -r tests/test-requirement.txt
+          python -m pip install -r requirements.txt
+          python -m pip install -r tests/requirements.txt
       - name: Runnning tests with pytest.
         run: |
           set -o pipefail

.github/workflows/typing_checker.yaml

@@ -20,13 +20,13 @@ jobs:
           python-version: ${{ matrix.python-version }}
           cache: 'pip'
           cache-dependency-path: |
-            **/requirement.txt
-            **/test-requirement.txt
+            **/requirements.txt
+            **/typing-requirements.txt
       - name: Install dependencies.
         run: |
           python -m pip install --upgrade pip
-          python -m pip install -r requirement.txt
-          python -m pip install -r tests/test-requirement.txt
+          python -m pip install -r requirements.txt
+          python -m pip install -r typing-requirements.txt
       - name: Running static types checker.
         run: |
           mypy

Dockerfile

@@ -3,8 +3,8 @@ FROM base as builder
 RUN apk add build-base
 RUN mkdir /install
 WORKDIR /install
-COPY requirement.txt /requirement.txt
-RUN pip install --prefix=/install -r /requirement.txt
+COPY requirements.txt /requirements.txt
+RUN pip install --prefix=/install -r /requirements.txt
 FROM base
 COPY --from=builder /install /usr/local
 RUN mkdir -p /app/agent

README.md

@@ -1,6 +1,7 @@
 # OXO Template Agent
 
-This repo is a template for building an [Ostorlab](https://github.com/ostorlab/ostorlab) agent in Python. It ships with good best practices like:
+This repo is a template for building an [OXO](https://github.com/ostorlab/ostorlab) agent in Python. It ships with
+good best practices like:
 
 * Github actions workflow
 * Linting checks with Ruff
@@ -16,6 +17,36 @@ Here are links to good resources to get started:
 * [Debugging and Testing Agents](https://oxo.ostorlab.co/tutorials/debugging_agents)
 * [Understand OXO Internals](https://oxo.ostorlab.co/tutorials/life_of_a_scan)
 
+## Contributing
+
+To contribute to this project, follow these steps:
+1. Fork this repository.
+2. Clone your forked repository: `git clone <your_fork_url>`
+3. Navigate into your repository's directory: `cd <repository_directory>`
+4. Create a new branch: `git checkout -b <branch_name>`.
+5. Install the dependencies: `pip install -r requirements.txt`.
+6. Make your changes.
+7. Ensure the tests pass:
+    ```sh
+    pip install -r tests/requirements.txt
+    pytest .
+    ```
+8. Ensure the linter passes:
+    ```sh
+    pip install -r linting-requirements.txt
+    ruff format .
+    ruff check .
+    ```
+9. Ensure the static type checks pass:
+    ```sh
+    pip install -r typing-requirements.txt
+    mypy
+    ```
+10. Commit your changes: `git commit -m '<commit_message>'`.
+11. Push to the remote branch: `git push origin <branch_name>`.
+12. Create a pull request from the forked repository.
+
+
 ## Ideas for Agents to build
 
 Implementation of popular tools like:

typing-requirements.txt

@@ -0,0 +1,3 @@
+mypy
+ruff
+typing-extensions