CONTRIBUTING.md

Contributing to SafeSCARF Connector

We welcome contributions to SafeSCARF Connector! Before you start, please read this guide to learn how to contribute effectively to the project.

Table of Contents

• Contributing to SafeSCARF Connector
  • Table of Contents
  • Getting Started
    • Prerequisites
    • Installation
  • Development Workflow
    • Code Style
    • Testing
  • Commit Guidelines
    • Pre-Commit Hooks
  • Submitting Changes

Getting Started

Prerequisites

Before you begin, make sure you have the following tools installed:

• Git
• Python

Installation

1. Clone the repository:

   git clone https://gitlab.devops.telekom.de/secureops/safescarf/safescarf-connector.git
   cd safescarf-connector

2. Create a virtual environment (optional but recommended):

   python -m venv venv
   source venv/bin/activate

3. Install the project dependencies:

   pip install -r requirements.txt

Development Workflow

Code Style

We use pre-commit to ensure code consistency. Before making any commits, please install it by running:

pip install pre-commit
pre-commit install

This will set up pre-commit hooks that will run checks on your code for things like trailing whitespace, YAML formatting, and Markdown linting. These checks help ensure that your contributions meet our coding standards.

Testing

There are no test available currently - therefore this step can be skipped!

Make sure your code passes all tests before submitting a pull request. You can run the tests using:

pytest

Commit Guidelines

Pre-Commit Hooks

To ensure that your commits pass the pre-commit hooks, you can manually run the hooks with:

pre-commit run --all-files

We highly recommend running this command before making a commit. If any issues are found, pre-commit will provide instructions on how to fix them.

Submitting Changes

1. Create a new branch:

   git checkout -b my-feature-branch

2. Make your changes, add and commit:

   git add .
   git commit -m "Description of your changes"

3. Push your branch to the repository:

   git push origin my-feature-branch

4. Create a pull request on GitHub with a clear description of your changes.

5. Wait for the code review and address any feedback.

6. Once your changes are approved, they will be merged into the main branch.

Thank you for contributing to SafeSCARF Connector!