|
| 1 | +# Contributing to Low Level Design LLD Using Python |
| 2 | + |
| 3 | +Welcome to the Low Level Design LLD Using Python project! |
| 4 | +Thank you for taking the time to contribute. We’re excited to collaborate with fellow engineers and learners to make this a world-class resource for system design. |
| 5 | + |
| 6 | + |
| 7 | +## How to Contribute |
| 8 | + |
| 9 | +### 1. Fork the Repository |
| 10 | + |
| 11 | +Click the **Fork** button in the top right corner of this repo to create your copy. |
| 12 | + |
| 13 | +### 2. Clone Your Fork |
| 14 | + |
| 15 | +```bash |
| 16 | +$ git clone https://github.com/raj713335/Low_Level_Design_LLD_Using_Python.git |
| 17 | +$ cd Low_Level_Design_LLD_Using_Python |
| 18 | +```` |
| 19 | + |
| 20 | +### 3. Create a Feature Branch |
| 21 | + |
| 22 | +```bash |
| 23 | +$ git checkout -b feature/your-feature-name |
| 24 | +``` |
| 25 | + |
| 26 | +### 4. Make Your Changes |
| 27 | + |
| 28 | +* Follow the existing folder and naming conventions. |
| 29 | +* Keep your code clean, modular, and well-documented. |
| 30 | +* If adding a new algorithm: |
| 31 | + |
| 32 | + * Place it in the appropriate section. |
| 33 | + * Include comments and usage examples. |
| 34 | +* If updating documentation: |
| 35 | + |
| 36 | + * Maintain consistent formatting. |
| 37 | + * Use Markdown best practices. |
| 38 | + |
| 39 | +### 5. Test Your Contribution |
| 40 | + |
| 41 | +Run your code and verify it works correctly. Add edge cases and examples where appropriate. |
| 42 | + |
| 43 | +### 6. Commit and Push |
| 44 | + |
| 45 | +```bash |
| 46 | +$ git add . |
| 47 | +$ git commit -m "Add: Description of your change" |
| 48 | +$ git push origin feature/your-feature-name |
| 49 | +``` |
| 50 | + |
| 51 | +### 7. Open a Pull Request |
| 52 | + |
| 53 | +Submit a pull request from your branch to the `main` branch of this repository. Fill out the PR template with: |
| 54 | + |
| 55 | +* A brief summary of your changes |
| 56 | +* Related issue (if applicable) |
| 57 | +* Screenshots or logs for UI/code changes |
| 58 | + |
| 59 | +--- |
| 60 | + |
| 61 | +## Contribution Guidelines |
| 62 | + |
| 63 | +* Keep commits atomic and meaningful. |
| 64 | +* Use clear and descriptive names for files, folders, and variables. |
| 65 | +* Include docstrings/comments for all functions and algorithms. |
| 66 | +* Maintain cross-platform compatibility (especially for scripts). |
| 67 | +* Do **not** modify files unrelated to your contribution. |
| 68 | +* Run linters and format your code (e.g., `black`, `flake8`). |
| 69 | +* Contributions should be beginner-friendly and educational. |
| 70 | +* Add references or links for advanced concepts where needed. |
| 71 | + |
| 72 | +--- |
| 73 | + |
| 74 | +## Contribution Ideas |
| 75 | + |
| 76 | +You can contribute in many ways: |
| 77 | + |
| 78 | +* Add new Low Level design patterns or algorithms. |
| 79 | +* Improve documentation or examples |
| 80 | +* Create diagrams or visuals for concepts |
| 81 | +* Submit bug fixes or optimizations |
| 82 | +* Translate content into other languages |
| 83 | +* Add test cases or edge scenarios |
| 84 | +* Create presentation slides or learning guides |
| 85 | + |
| 86 | +--- |
| 87 | + |
| 88 | +## Development Setup |
| 89 | + |
| 90 | +* Python 3.7+ |
| 91 | +* pip |
| 92 | + |
| 93 | +To install common dependencies: |
| 94 | + |
| 95 | +```bash |
| 96 | +pip install -r requirements.txt |
| 97 | +``` |
| 98 | + |
| 99 | +For specific modules, refer to the README or project root guide. |
| 100 | + |
| 101 | +--- |
| 102 | + |
| 103 | +## Support & Questions |
| 104 | + |
| 105 | +* Open an [Issue](https://github.com/raj713335/Low_Level_Design_LLD_Using_Python/issues) for bugs, questions, or feature requests. |
| 106 | +* Join discussions in the community tab or comments. |
| 107 | +* Please search existing issues before creating a new one. |
| 108 | + |
| 109 | +--- |
| 110 | + |
| 111 | +## License |
| 112 | + |
| 113 | +By contributing, you agree that your contributions will be licensed under the [GNU Lesser General Public License v2.1](LICENSE). |
| 114 | + |
| 115 | +--- |
| 116 | + |
| 117 | +## Acknowledgment |
| 118 | + |
| 119 | +Your efforts make this project better! Whether it’s code, docs, or just a bug report — **every bit helps**. Let’s build the ultimate system design masterclass together. |
| 120 | + |
| 121 | +## Happy Contributing! |
| 122 | + |
0 commit comments