Skip to content

Latest commit

 

History

History
86 lines (60 loc) · 1.92 KB

File metadata and controls

86 lines (60 loc) · 1.92 KB

Thank you for your interest in contributing to this repository!
This project focuses on clean, practical, and well-documented implementations of Software Design Patterns in Java.

Contributions that improve learning value, code quality, and structure are always welcome.


Ways to Contribute

You can contribute by:

  • Adding new Design Pattern implementations
    (e.g., Strategy, Command, State, Template Method)
  • Improving existing implementations
  • Refactoring code for better readability and structure
  • Enhancing documentation or README files
  • Adding UML diagrams or output screenshots
  • Fixing bugs or improving consistency

Repository Structure

Each design pattern must follow this structure:


Pattern_Name/
├── README.md
├── src/
│   └── Java source files
└── img/
└── Output screenshots/diagrams

Guidelines:

  • Use Java
  • Each pattern must be placed in its own folder
  • Folder names should be descriptive and consistent
  • Patterns should be implemented independently
  • Follow Object-Oriented Design principles

Code Guidelines

  • Follow clean code and OOP best practices
  • Keep classes focused on a single responsibility
  • Avoid unnecessary complexity
  • Ensure the code compiles and runs successfully
  • Add comments only where logic is not obvious

Documentation Guidelines

Each pattern must include a README.md that explains:

  • The problem statement
  • The intent of the design pattern
  • Class responsibilities and interactions
  • Example output and behavior

Screenshots and diagrams should be placed in the img/ folder.


Contribution Workflow

  1. Fork this repository
  2. Create a new branch
 git checkout -b feature/pattern-name
  1. Make your changes
  2. Commit your work
 git commit -m "Add <Pattern Name> design pattern"
  1. Push to your fork
  2. Open a Pull Request with a clear description