Skip to content

Commit 54ce57b

Browse files
authored
Update README.md
1 parent 6a020d4 commit 54ce57b

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
# Low-Level System Design in Go
23

34
Welcome to the **Low-Level System Design in Go** repository! This repository contains various low-level system design problems and their solutions implemented in Go. The primary aim is to demonstrate the design and architecture of systems through practical examples.
@@ -10,6 +11,7 @@ Welcome to the **Low-Level System Design in Go** repository! This repository con
1011
- [Library Management System](#library-management-system)
1112
- [Vending Machine System](#vending-machine-system)
1213
- [Social Media Platform](#social-media-platform)
14+
- [Contributing Guidelines](#contributing-guidelines)
1315

1416
## Overview
1517

@@ -97,3 +99,22 @@ The fifth project in this repository is a **Social Media Platform**. This system
9799
- **Error Handling**: Provides informative error messages for actions such as attempting to interact with nonexistent users or posts.
98100
- **Encapsulation of Features**: Each feature (users, posts, friendships) is encapsulated in a separate manager class, promoting modularity and ease of maintenance.
99101

102+
## Contributing Guidelines
103+
Contributions to expand this repository with more low-level system design problems and solutions are welcomed. Here’s how you can contribute:
104+
105+
### Steps to Contribute
106+
107+
- Choose a System Design Problem.
108+
- Select a problem to implement, feel free to propose it in an issue.
109+
- Open a new issue in the repository to let maintainers know about the system design problem you plan to add. Provide a brief overview of the problem and your approach.
110+
- Follow Repository Standards. Use Go for the implementation. Follow the project structure and coding style used in the repository.
111+
- Include a clear README section for the problem with the following details: problem description, key features, design patterns used, concurrency or error handling highlights (if any)
112+
- Fork the repository, make your changes, and submit a pull request.
113+
- Ensure your code is clean, well-documented, and tested.
114+
- Your pull request will be reviewed by the maintainer. After addressing feedback, it will be merged into the repository.
115+
116+
### Contribution Tips
117+
- Break the problem into smaller components and implement them incrementally.
118+
- Document your solution clearly to help others understand your implementation.
119+
120+
Thank you for contributing to Low-Level System Design in Go!

0 commit comments

Comments
 (0)