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

What "patterns & principles" should be included? #2

Open
rskopecek opened this issue Jan 19, 2019 · 0 comments
Open

What "patterns & principles" should be included? #2

rskopecek opened this issue Jan 19, 2019 · 0 comments
Assignees
Milestone

Comments

@rskopecek
Copy link
Owner

One of the forms of situational expression is the tagging of various patterns and principles. Sometimes they can be use to simplify the message to convey or help point the developer who will address it to something they should learn about or rethink first.

For example: [SideEffects(solid: Solid.SingleResponsibility)]

The options are grouped and isolated to support bitwise stacking of multiple enum values. Names are preferred in long form to ensure readability. For example, SRP may be well known to the reviewer but not so much for the developer having to do something about it.

The items currently included can be found in the link below which are only a conversational starter.

https://github.com/rskopecek/CodeDocs/tree/master/src/CodeDocs/PatternsAndPrinciples

@rskopecek rskopecek added this to the 0.1.x milestone Jan 19, 2019
@rskopecek rskopecek self-assigned this Jan 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant