Skip to content

Latest commit

 

History

History
89 lines (67 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

89 lines (67 loc) · 2.98 KB

Contributing to Design Patterns in a Nutshell

First off, thank you for taking the time to contribute to Design Patterns in a Nutshell! 🎉 Your contributions make this project a valuable resource for developers worldwide.

Ways to Contribute

1. Reporting Bugs

If you encounter any bugs or errors in the examples or documentation:

  • Open an issue with the following details:
    • Description: What went wrong?
    • Steps to Reproduce: Provide clear steps to replicate the issue.
    • Environment: Include details about your operating system, programming language, and version.

2. Suggesting Improvements

Have an idea to improve the repository? Great! Here’s how:

  • Open an issue describing your suggestion.
  • If applicable, provide examples or links to resources that support your idea.

3. Submitting Pull Requests

Want to add new examples, enhance documentation, or fix bugs? Follow these steps:

  1. Fork the Repository: Click the "Fork" button on the top-right of the repository page.
  2. Clone the Fork: 
    git clone https://github.com/dizzydroid/DesignPatternsNutshell.git
cd DesignPatternsNutshell
  3. Create a New Branch: 
    git checkout -b feature/your-feature-name
  4. Make Your Changes:
    • Add or update code examples.
    • Enhance the documentation, including UML diagrams where applicable.
  5. Test Your Changes:
    • Ensure the examples are runnable and meet the repository standards.
  6. Commit and Push: 
    git add .
git commit -m "Add your detailed commit message here"
git push origin feature/your-feature-name
  7. Open a Pull Request:
    • Go to the original repository.
    • Click "Pull Requests" and then "New Pull Request."
    • Fill in the template and submit your pull request.

Pull Request Guidelines

  • Follow the existing folder and file structure.
  • Include a brief description of your changes in the pull request.
  • Ensure your code examples include comments for clarity.
  • Update the README.md of the corresponding pattern with:
    • Clear instructions for running the example.
    • A UML diagram, if applicable.
  • Make sure your changes do not break existing examples.

Style Guide

To maintain consistency:

  • Follow standard naming conventions for files and folders.
  • Indent code properly and use clear, descriptive variable names.
  • Keep documentation concise and easy to understand.

UML Diagrams

If your contribution includes a new or updated UML diagram:

  1. Use a tool like PlantUML or draw.io.
  2. Embed the diagram directly in the README.md file of the pattern using markdown syntax.
  3. Provide a clear and simple explanation of the diagram in the documentation.

Code of Conduct

By contributing, you agree to follow the Code of Conduct for this repository.

Thank you for helping improve Design Patterns in a Nutshell! Your efforts are truly appreciated. 🚀