Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
128 lines (96 loc) · 3.37 KB

CONTRIBUTING.md

File metadata and controls

128 lines (96 loc) · 3.37 KB

Contributing to the GRC Engineer Directory

Thank you for your interest in joining the GRC Engineer Directory! This guide will walk you through the submission process.

How to Add Yourself

Step 1: Fork the Repository

Click the "Fork" button at the top right of this repository to create your own copy.

Step 2: Create Your Profile

  1. Copy engineers/_template.md to a new file named engineers/{your-github-username}.md
    • Example: If your GitHub username is jsmith, create engineers/jsmith.md
  2. Fill out all required fields and any optional fields you'd like to include
  3. Write a brief bio in the markdown body section

Step 3: Submit a Pull Request

  1. Commit your new profile file
  2. Open a Pull Request to the main repository
  3. Fill out the PR template checklist
  4. Wait for a maintainer to review and merge your submission

Profile Fields

Required Fields

Field Description Example
name Your full name Jane Smith
github Your GitHub username (must match filename) jsmith
specializations Array of your areas of expertise [Cloud Security, Compliance Automation]

Optional Fields

Field Description Example
title Your current job title Senior GRC Engineer
company Your current employer Acme Corp
location City, Country San Francisco, USA
linkedin LinkedIn profile URL https://linkedin.com/in/jsmith
twitter Twitter/X handle @jsmith
blog Personal website or blog https://jsmith.dev
frameworks Compliance frameworks you work with [SOC 2, FedRAMP, ISO 27001]
certifications Professional certifications [CISSP, CISA, CCSK]
available_for What you're open to [mentoring, speaking]
projects Notable projects (array of objects) See template

Valid Values

Specializations

Choose from the following (or suggest new ones):

  • Cloud Security
  • Compliance Automation
  • Risk Management
  • Security Governance
  • Audit & Assurance
  • Third-Party Risk
  • Privacy
  • Security Architecture
  • Incident Response
  • Security Operations
  • Vulnerability Management
  • Identity & Access Management

Frameworks

Choose from the following (or suggest new ones):

  • SOC 2
  • FedRAMP
  • ISO 27001
  • ISO 27017
  • ISO 27018
  • HIPAA
  • PCI-DSS
  • NIST CSF
  • NIST 800-53
  • NIST 800-171
  • GDPR
  • CCPA
  • CMMC
  • StateRAMP
  • HITRUST
  • CSA STAR

Available For

  • mentoring
  • speaking
  • consulting
  • open-source
  • hiring
  • freelance
  • collaboration

Guidelines

Do

  • Use your real name and professional information
  • Keep your bio concise and professional (2-4 paragraphs)
  • Include accurate information about your experience
  • Update your profile if your information changes
  • Link to professional profiles and projects you're proud of

Don't

  • Include false or misleading information
  • Add promotional or marketing content
  • Include sensitive or private information
  • Submit profiles for other people without their consent
  • Use the directory for recruiting or sales purposes

Updating Your Profile

To update your existing profile:

  1. Fork the repository (if you haven't already)
  2. Edit your engineers/{github-username}.md file
  3. Submit a Pull Request with your changes

Questions?

If you have questions about the submission process, please open an issue in the repository.