leancodepl / leancodepl/flutter_corelibrary
Cleaner README for cqrs
Open
@Albert221 is already working on this.
Since Jul 14, 2022.
documentation
p: cqrs
- Dominant language
- Dart
- Stars
- 89
- Forks
- 12
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 2
Description
As the package got more mature it's a good moment to enhance its README with a bit more advanced features.
Any feedback is welcome.
The current proposal for enhancements:
- Description of
Query,Command, andOperationCQRS methods, abstractly.- Describing
ValidationErrors
- Describing
- Note showing how to create a query/command
- Note shortly introducing to the Dart contracts generator.
Yes, the package isn't tied with the generator anyhow, but in real life, those two are at least almost always used together and it'd be a good idea to explain the concept with real use-case tips.
- Note shortly introducing to the Dart contracts generator.
- Maybe a simple graphical (i.e. a logo) for the package?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.