Contributing

We welcome contributions to the Google SecOps SDK for Python! This page provides guidelines for contributing to the project.

The Google SecOps Wrapper SDK welcomes contributions. Please submit your PR. Be sure to include tests!

Development Setup

To set up your development environment:

  1. Clone the repository:

    git clone https://github.com/google/secops-wrapper.git
cd secops-wrapper

  2. Create a virtual environment:

    python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

  3. Install development dependencies:

    pip install -e ".[dev]"

  4. Run tests:

    pytest

Code Style

We follow the Google Python Style Guide. Please ensure your code adheres to this style guide before submitting pull requests.

Pull Request Process

  1. Fork the repository

  2. Create a feature branch

  3. Make your changes

  4. Run tests to ensure they pass

  5. Submit a pull request

Documentation

When contributing new features, please update the documentation accordingly. This includes:

  1. Updating the relevant documentation files in the docs/ directory

  2. Adding docstrings to new functions and classes

  3. Updating examples if necessary