Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhanced pattern documentation #2590

Closed
wants to merge 1 commit into from
Closed

Enhanced pattern documentation #2590

wants to merge 1 commit into from

Conversation

SkSadaf
Copy link

@SkSadaf SkSadaf commented Sep 29, 2023

In this commit, I've improved the documentation for the following design patterns:

  • Collection Pipeline: Added real-world examples, plain language explanation, and Wikipedia reference. Also included a programmatic example.
  • Commander: Provided real-world scenarios, plain language description, and a Wikipedia link. Added a programmatic example where applicable.
  • CQRS: Enhanced documentation with real-world illustrations, a simplified explanation in plain words, and a Wikipedia reference. Programmatic examples will be added as needed.
    These updates align with the acceptance criteria, ensuring that each pattern's README.md file contains a comprehensive explanation.

In this commit, I've improved the documentation for the following design patterns:
- Collection Pipeline: Added real-world examples, plain language explanation, and Wikipedia reference. Also included a programmatic example.
- Commander: Provided real-world scenarios, plain language description, and a Wikipedia link. Added a programmatic example where applicable.
- CQRS: Enhanced documentation with real-world illustrations, a simplified explanation in plain words, and a Wikipedia reference. Programmatic examples will be added as needed.

These updates align with the acceptance criteria, ensuring that each pattern's README.md file contains a comprehensive explanation.
@sonarqubecloud
Copy link

sonarqubecloud bot commented Oct 1, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

Copy link
Owner

@iluwatar iluwatar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation looks otherwise good, but we can't accept Python code. The idea is to use the pattern example code in the explanation. See the other patterns for examples.

Copy link

stale bot commented Nov 13, 2023

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@stale stale bot added the status: stale issues and pull requests that have not had recent interaction label Nov 13, 2023
Copy link

stale bot commented Dec 28, 2023

Closed due to inactivity. Thank you for your contributions.

@stale stale bot closed this Dec 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: stale issues and pull requests that have not had recent interaction status: under review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants