Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

44 lines (31 loc) · 1.49 KB

Contributing to the Design Pattern Repository

Thank you for considering contributing to this repository! This document outlines the process for contributing and the guidelines we follow to maintain a high-quality project.

Ways to Contribute

1. Reporting Issues

If you find a bug, have a feature request, or notice something missing in the documentation, please create an issue using the appropriate template.

When reporting an issue, include:

  • A clear and descriptive title.
  • A detailed description of the problem or request.
  • Steps to reproduce the issue (for bugs).
  • Any relevant screenshots or code snippets.

2. Adding or Improving Examples

You can contribute by adding new examples or improving existing ones:

  1. Follow the repository's structure to place your example in the correct folder.
  2. Ensure your code adheres to the repository's coding style.
  3. Add comments explaining the logic of your example, where necessary.

3. Updating Documentation

You can help improve documentation by:

  • Fixing typos or grammatical errors.
  • Adding more details to existing documentation.
  • Writing documentation for new design patterns.

Workflow for Contributing

  1. Fork the Repository
    Click the "Fork" button in the top-right corner of this repository to create your copy.

  2. Clone Your Fork
    Clone the forked repository to your local machine:

    git clone https://github.com/your-username/design-pattern.git