Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
122 lines (78 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

122 lines (78 loc) · 3.15 KB
Raw

Contributing to Low Level Design LLD Using Python

Welcome to the Low Level Design LLD Using Python project! 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.

How to Contribute

1. Fork the Repository

Click the Fork button in the top right corner of this repo to create your copy.

2. Clone Your Fork

$ git clone https://github.com/raj713335/Low_Level_Design_LLD_Using_Python.git
$ cd Low_Level_Design_LLD_Using_Python

3. Create a Feature Branch

$ git checkout -b feature/your-feature-name

4. Make Your Changes

  • Follow the existing folder and naming conventions.

  • Keep your code clean, modular, and well-documented.

  • If adding a new algorithm:

    • Place it in the appropriate section.
    • Include comments and usage examples.

  • If updating documentation:

    • Maintain consistent formatting.
    • Use Markdown best practices.

5. Test Your Contribution

Run your code and verify it works correctly. Add edge cases and examples where appropriate.

6. Commit and Push

$ git add .
$ git commit -m "Add: Description of your change"
$ git push origin feature/your-feature-name

7. Open a Pull Request

Submit a pull request from your branch to the main branch of this repository. Fill out the PR template with:

  • A brief summary of your changes
  • Related issue (if applicable)
  • Screenshots or logs for UI/code changes

Contribution Guidelines

  • Keep commits atomic and meaningful.
  • Use clear and descriptive names for files, folders, and variables.
  • Include docstrings/comments for all functions and algorithms.
  • Maintain cross-platform compatibility (especially for scripts).
  • Do not modify files unrelated to your contribution.
  • Run linters and format your code (e.g., black, flake8).
  • Contributions should be beginner-friendly and educational.
  • Add references or links for advanced concepts where needed.

Contribution Ideas

You can contribute in many ways:

  • Add new Low Level design patterns or algorithms.
  • Improve documentation or examples
  • Create diagrams or visuals for concepts
  • Submit bug fixes or optimizations
  • Translate content into other languages
  • Add test cases or edge scenarios
  • Create presentation slides or learning guides

Development Setup

  • Python 3.7+
  • pip

To install common dependencies:

pip install -r requirements.txt

For specific modules, refer to the README or project root guide.

Support & Questions

  • Open an Issue for bugs, questions, or feature requests.
  • Join discussions in the community tab or comments.
  • Please search existing issues before creating a new one.

License

By contributing, you agree that your contributions will be licensed under the GNU Lesser General Public License v2.1.

Acknowledgment

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.

Happy Contributing!