Contributing

Contributing

Thank you for your interest in contributing to the Linux Security Audit Project! This page summarizes key points — for the full guidelines, see CONTRIBUTING.md in the main repository.

---

Ways to Contribute

• 🐛 Report bugs — Found an issue? Open a GitHub Issue
• 💡 Suggest features — Have an idea? Start a Discussion
• 📝 Improve documentation — Enhance wiki pages, add examples, fix typos
• 🔧 Submit bug fixes — Fix issues and submit pull requests
• ✨ Add checks — Contribute new security checks or modules
• 🧪 Test — Validate on different Linux distributions
• 🌐 Translate — Help with internationalization

Development Workflow

1. Fork the repository
2. Create a feature branch (git checkout -b feature/NewSecurityCheck)
3. Follow coding standards (see Development Guide)
4. Test on multiple distributions
5. Update documentation
6. Commit changes (git commit -m 'Add: New SSH key rotation check')
7. Push to branch (git push origin feature/NewSecurityCheck)
8. Open a Pull Request with detailed description

Module Development Checklist

• Module file: modules/module_name.py
• Follows naming convention and structure
• Uses shared_components caching API where applicable
• Standalone execution works: python3 modules/module_name.py
• Integrates with orchestrator: python3 linux_security_audit.py -m NAME
• Works with profiling: python3 linux_security_audit.py -m NAME --profile
• All checks produce consistent result format
• Compliance scores compute correctly
• Remediation commands are valid
• Documentation updated

Coding Standards

• Python 3.7+ (dataclasses required)
• Zero external dependencies (stdlib only)
• Comprehensive code comments and docstrings
• Error handling with graceful degradation
• OS-aware checks where applicable

---

See CONTRIBUTING.md for the complete guidelines.

← Back to Development Guide | Home