Skip to content

contributing.md

Latest commit

 

History

History
125 lines (88 loc) · 3.87 KB

contributing.md

File metadata and controls

125 lines (88 loc) · 3.87 KB

Contributing to the Telecom Security Research Project

Thank you for your interest in contributing to the telco-sec.com research project! This document outlines the process for contributing to our research, tools, and documentation.

Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. Contribution Process
  4. Research Contributions
  5. Tool Development
  6. Documentation
  7. Community Engagement
  8. Licensing

Code of Conduct

All contributors are expected to adhere to our Code of Conduct. By participating, you agree to uphold these standards and respect all community members.

Getting Started

Prerequisites

Before contributing, ensure you have:

  • A GitHub account
  • Familiarity with Git and GitHub workflows
  • Basic understanding of telecom security concepts
  • Reviewed our existing research and documentation

Environment Setup

  1. Fork the repository
  2. Clone your forked repository locally
  3. Set up the development environment following the instructions in DEVELOPMENT.md
  4. Create a new branch for your contribution

Contribution Process

1. Select a Task

  • Check our Issue Tracker for open tasks
  • Look for issues labeled "good first issue" if you're new
  • Join discussions in relevant issues to express interest
  • Create a new issue if you identify a gap not currently addressed

2. Work on Your Contribution

  • Create a feature branch: git checkout -b feature/your-feature-name
  • Follow our Coding Standards for tool development
  • Follow our Research Methodology for security research
  • Make regular commits with clear messages

3. Submit Your Contribution

  • Ensure your code/research passes all tests
  • Update documentation as needed
  • Push your changes to your fork
  • Create a pull request to the main repository
  • Fill out the pull request template completely

4. Review Process

  • At least two maintainers will review your contribution
  • Address any feedback or requested changes
  • Participate in discussions about your contribution
  • Once approved, a maintainer will merge your contribution

Research Contributions

Research Proposal

For substantial research contributions:

  1. Create an issue using the "Research Proposal" template
  2. Include the following information:
    • Research topic and scope
    • Methodology
    • Expected outcomes
    • Required resources
    • Timeline
  3. Wait for maintainer approval before proceeding

Research Quality Standards

All research contributions must:

  • Follow our Research Methodology
  • Provide reproducible results
  • Include complete documentation
  • Adhere to responsible disclosure principles
  • Properly cite all sources and prior work
  • Include practical security implications

Vulnerability Research

For vulnerability research:

  1. Use our standardized testing methodology
  2. Document all findings using the vulnerability template
  3. Include proof-of-concept code when appropriate
  4. Follow responsible disclosure procedures
  5. Work with maintainers on disclosure timeline
  6. Provide remediation guidance when possible

Tool Development

Tool Contribution Requirements

New tools should:

  • Solve a specific telecom security problem
  • Include comprehensive documentation
  • Have proper error handling
  • Include unit and/or integration tests
  • Follow our coding standards
  • Be compatible with our existing toolset

Testing Requirements

All tool

Trademarks:
All product names, logos, and brands are property of their respective owners. All company, product, and service names used in this documentation are for identification purposes only. Use of these names, logos, and brands does not imply endorsement.