Skip to content

Latest commit

 

History

History
49 lines (37 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

49 lines (37 loc) · 1.25 KB
Raw

💼 Contribution Guidelines

👋 Hello, Contributors! Welcome to the heart of System Design Universe.

🚀 Getting Started:

  1. Fork: Use the fork button for your personal copy.

  2. Clone: Bring it local.

    git clone https://github.com/jigsaw373/system-design.git

  3. Setup: Power up with diagrams.

    pip install diagrams

🛠 Contributing:

  1. Design Insights:

    • If adding a new system design, create its dedicated directory.
    • Include a README.md detailing the architecture.
    • Craft illustrative diagrams:
    from diagrams import Diagram
with Diagram("Your System Diagram"):
    # Relevant nodes and connections

  2. Commit:

    git add .
git commit -m "verb: add more details"

  3. Push:

    git push origin main

  4. Pull Request: Propose your changes via PR. Our team will review shortly.

📌 Best Practices:

  • Documentation: Clarity is key. Detail your designs.
  • Sync Regularly: Pull updates from your fork to stay current.
  • Engage Respectfully: Feedback is a growth tool. Let's maintain decorum.

By contributing, you adhere to our Code of Conduct.