Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
91 lines (68 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

91 lines (68 loc) · 2.11 KB

Contributing to SentinelPrime

Thank you for your interest in contributing to SentinelPrime! This is a research project exploring AI-driven security control planes.

How to Contribute

Research Contributions

  • Share findings from your experiments
  • Propose new detection algorithms
  • Improve ML model accuracy
  • Document attack scenarios

Code Contributions

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Add tests if applicable
  5. Commit your changes (git commit -m 'Add amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Bug Reports

Use GitHub Issues to report bugs. Include:

  • Description of the issue
  • Steps to reproduce
  • Expected vs. actual behavior
  • Environment details (OS, Docker version, etc.)
  • Logs if applicable

Feature Requests

We welcome ideas! Open an issue with:

  • Clear description of the feature
  • Use case / motivation
  • Potential implementation approach

Development Setup

  1. Clone the repository
  2. Install development dependencies: 
    pip install -r control-plane/requirements.txt
pip install pytest black flake8
  3. Run tests: 
    pytest
  4. Format code: 
    black .

Code Style

  • Follow PEP 8 for Python code
  • Use meaningful variable names
  • Add docstrings to functions and classes
  • Keep functions focused and concise
  • Add comments for complex logic

Testing

  • Write tests for new features
  • Ensure existing tests pass
  • Test with different configurations
  • Document test scenarios

Documentation

  • Update README.md for user-facing changes
  • Update ARCHITECTURE.md for design changes
  • Add examples in docs/ for new features
  • Keep comments up-to-date

Research Ethics

This project deals with security and attack simulation:

  • Only test in isolated lab environments
  • Respect privacy and data protection
  • Follow responsible disclosure for vulnerabilities
  • Document safety considerations

Questions?

Open an issue or reach out to the maintainers.

Thank you for contributing to SentinelPrime! 🛡️