Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
86 lines (61 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

86 lines (61 loc) · 1.59 KB

Contributing Guide

Thank you for contributing to Linux101 — BootToRoot.

This repository is part of the broader System and Security Guide ecosystem. The primary goal of this repository is maintaining high-quality infrastructure education documentation.

Contribution Types

We accept contributions for:

  • technical corrections
  • outdated command fixes
  • broken lab instructions
  • typo fixes
  • translation improvements
  • quiz improvements
  • documentation improvements
  • screenshot updates
  • learning resource improvements

Contributions We Usually Do Not Accept

  • unstructured topic additions
  • breaking repository structure
  • random formatting changes
  • low-quality AI generated content
  • duplicated content
  • off-topic submissions

Repository Structure Rules

Do not modify:

  • day numbering logic
  • folder hierarchy
  • documentation naming conventions

without maintainers approval.

Documentation Standards

Every document should preserve:

  • technical accuracy
  • reproducibility
  • structured formatting
  • enterprise realism
  • practical applicability

Markdown Rules

Maintain:

  • heading consistency
  • code block formatting
  • file path consistency
  • screenshot references
  • numbering conventions

Lab Contribution Rules

Labs must include:

  • objective
  • prerequisites
  • implementation steps
  • expected output
  • troubleshooting notes

Pull Request Process

  1. Fork repository
  2. Create branch
  3. Submit changes
  4. Open pull request
  5. Wait for review

Review Criteria

All submissions are reviewed for:

  • technical accuracy
  • clarity
  • reproducibility
  • consistency
  • educational value