CONTRIBUTING.md

Contributing to ML Pipeline for Cybersecurity Purple Teaming

First off, thank you for considering contributing to our project! 🎉

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs 🐛

• Use the GitHub issue tracker
• Check if the bug has already been reported
• Include detailed steps to reproduce the bug
• Provide system information and stack traces if applicable

Suggesting Enhancements 💡

• First, read the documentation to make sure the functionality doesn't already exist
• Use the GitHub issue tracker and clearly describe the feature
• Explain why this enhancement would be useful
• Keep the scope as narrow as possible

Pull Requests 🔧

1. Fork the repo and create your branch from main
2. If you've added code that should be tested, add tests
3. Ensure the test suite passes
4. Make sure your code lints
5. Issue that pull request!

Development Process

1. Setup Development Environment

   pip install -r requirements-dev.txt
   

2. Run Tests

   pytest
   

3. Code Style

   • Follow PEP 8 guidelines
   • Use meaningful variable names
   • Add comments for complex logic
   • Write docstrings for functions and classes

4. Commit Messages

   • Use clear, descriptive commit messages
   • Reference issues and pull requests
   • Keep commits atomic and focused

Documentation 📚

• Update README.md with details of changes to the interface
• Update docstrings and comments
• Add any new installation requirements

Thank you for your contribution! 🙏