Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (35 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 2.25 KB

Contributing to DevOps - Learn by Doing

Thanks for your interest in contributing! This project thrives on community input, and we welcome all kinds of contributions—whether it's adding new resources, improving descriptions, fixing links, or helping with the website.

How to Contribute

1. Add a New Resource

  • Find your resource category: Check the README for existing categories. If your resource doesn't fit, suggest a new category in your PR.
  • Add your link: Insert your resource under the correct heading, keeping the list alphabetical if possible.
  • Write a one-line description: Briefly explain what the resource offers (see style guide below).

2. Fix, Update, or Improve

  • Descriptions: Edit for clarity, consistency, and grammar.
  • Links: Check for broken links and update or remove as needed.
  • Organization: Suggest improvements to categories, tagging, or filtering.

3. Work on Issues

  • Browse the issue tracker for open tasks.
  • Issues labeled good first issue or help wanted are great places to start.

4. Improve the Website

  • All website code is in the /site directory (if present).
  • Frontend-only! Propose UI/UX improvements, features, or bug fixes.

Style Guide for Resources

  • Descriptions: One sentence, clear, and to the point.
  • Links: Only free, hands-on, high-quality resources.
  • Examples:
    • - [SadServers](https://sadservers.com/scenarios) - Practice Linux troubleshooting with real-world server problems.
    • - [Kubernetes Goat](https://madhuakula.com/kubernetes-goat/docs/) - A playground for learning Kubernetes security by doing.

Pull Request Process

  1. Fork this repository and create your branch from main.
  2. Make your changes.
  3. If you’re adding a new resource, double-check for duplicates!
  4. Open a pull request (PR) with a short description of your change.
  5. Be responsive to feedback or requests for changes from maintainers.

Community Standards

  • Be kind, inclusive, and respectful of others.
  • Adhere to our Code of Conduct.
  • Use clear and constructive communication.

Thank you for making DevOps - Learn by Doing a better resource for everyone!