👋 Hello, Contributors! Welcome to the heart of System Design Universe.
-
Fork: Use the fork button for your personal copy.
-
Clone: Bring it local.
git clone https://github.com/jigsaw373/system-design.git
-
Setup: Power up with diagrams.
pip install diagrams
-
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
-
Commit:
git add . git commit -m "verb: add more details"
-
Push:
git push origin main
-
Pull Request: Propose your changes via PR. Our team will review shortly.
- 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.