Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
102 lines (79 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

102 lines (79 loc) · 3.2 KB

Contributing to Cybersecurity FAQ

Thank you for your interest in contributing! This resource is community-driven, and your contributions help make it better for everyone.

📝 How to Contribute

Quick Contributions

  • Fix typos or broken links - Submit a PR directly
  • Add a resource - Append to the appropriate section
  • Improve explanations - Clarify confusing content

Larger Contributions

  1. Open an issue first - Discuss your proposed changes
  2. Fork the repository
  3. Create a feature branch: git checkout -b feature/your-feature-name
  4. Make your changes
  5. Submit a Pull Request

📋 Contribution Guidelines

Content Standards

  • Accuracy - Verify information before submitting
  • Actionable - Focus on practical, actionable advice
  • Beginner-friendly - Explain jargon when first used
  • Neutral - Avoid promoting specific paid products without alternatives
  • Current - Include version/date info for time-sensitive content

Formatting

  • Use consistent markdown formatting
  • Include tables for comparisons
  • Use collapsible sections (<details>) for lengthy FAQ answers
  • Provide descriptions for external links
  • Test all links before submitting

What We're Looking For

  • ✅ New FAQ questions with comprehensive answers
  • ✅ Updates to outdated information
  • ✅ Additional learning resources (free preferred)
  • ✅ Tool recommendations with descriptions
  • ✅ Career advice from industry professionals
  • ✅ Translations (create language-specific files)

What We Avoid

  • ❌ Promotional content for paid courses/products
  • ❌ Links to pirated content
  • ❌ Opinion pieces without factual basis
  • ❌ Duplicate content already covered

🔧 Development Setup

# Clone your fork
git clone https://github.com/YOUR-USERNAME/cybersecurity-faq.git

# Add upstream remote
git remote add upstream https://github.com/ismailtasdelen/cybersecurity-faq.git

# Keep your fork updated
git fetch upstream
git merge upstream/main

📁 File Structure

cybersecurity-faq/
├── README.md              # Main FAQ document
├── CONTRIBUTING.md        # This file
├── CODE_OF_CONDUCT.md     # Community guidelines
├── LICENSE                # MIT License
└── docs/
    ├── career-roadmaps.md     # Career path guides
    ├── certification-guide.md # Certification details
    ├── tools-resources.md     # Tool compendium
    ├── lab-setup-guide.md     # Lab setup instructions
    ├── interview-prep.md      # Interview preparation
    └── ctf-guide.md           # CTF getting started

🏷️ Issue Labels

Label Description
content Content additions or updates
fix Fixes for errors or broken links
enhancement Improvements to existing content
translation Language translations
question Questions needing answers

💬 Getting Help

  • Open an issue for questions
  • Join discussions in existing issues
  • Be respectful and constructive

📜 License

By contributing, you agree that your contributions will be licensed under the MIT License.

Thank you for helping make cybersecurity knowledge accessible to everyone! 🛡️