Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (42 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

66 lines (42 loc) · 1.51 KB

Contributing to ADR Runbooks

Thank you for your interest in contributing to Contrast Security's Application Detection and Response Runbooks. This document provides guidelines for contributions.

How to Contribute

  1. Fork the repository
  2. Create a new branch for your changes
  3. Make your changes
  4. Submit a pull request

Runbook Structure

Each runbook should follow this structure:

---
layout: runbook
title: "Title of the Runbook"
description: "Brief description of the security issue and its impact"
---

# Title

Brief introduction explaining the security issue.

## Example Events

Include example events showing different outcomes (Exploited, Blocked, etc).

## Decision Tree

Clear steps for triaging the event type.

## Response Procedures

Detailed procedures based on event outcome.

## Post-Incident Activities

Steps for documentation and follow-up.

Style Guidelines

  • Use clear, concise language
  • Include relevant code examples
  • Add decision trees for complex procedures
  • Include example events where applicable
  • Document post-incident procedures

Review Process

  1. All contributions will be reviewed for:

    • Technical accuracy
    • Adherence to style guidelines
    • Clarity and completeness
    • Formatting consistency

  2. Make requested changes if any are needed

  3. Once approved, changes will be merged

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.