Skip to content

Commit 1fb322a

Browse files
committed
Adding initial page for developer guidelines concept
1 parent f695b65 commit 1fb322a

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

development-guidelines.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
layout: default
3+
---
4+
5+
# Development Guidelines
6+
7+
## Conventions and Patterns
8+
9+
### Mediatr Components - Naming Conventions
10+
11+
The project has adopted a CQRS pattern using the Mediatr library. We have discussed ([read discussion](https://github.com/HTBox/allReady/issues/1262)) the naming for these components and agreed that we will *not* suffix them with "Async".
12+
13+
**Commands:**
14+
15+
A command message should end with "Command" and descibe the action that is intended. e.g.
16+
17+
- EditCampaignCommand
18+
- DeleteTaskCommand
19+
20+
The handlers should match the command message name with the suffix of "Handler". e.g.
21+
22+
- EditCampaignCommandHandler
23+
- DeleteTaskCommandHandler
24+
25+
**Queries:**
26+
27+
A query message should end with "Query" and describe the data it returns. e.g.
28+
29+
- EventSummaryQuery
30+
- TaskDetailQuery
31+
32+
The handlers should match the query message name with the suffix of "Handler". e.g.
33+
34+
- EventSummaryQueryHandler
35+
- TaskDetailQueryHandler

index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ <h2><a href="/finding-a-task.html">Finding a Task</a></h2>
2727
<h2><a href="/getting-the-code.html">Getting the Code</a></h2>
2828
<h2><a href="/building-the-project.html">Building the Project</a></h2>
2929
<h2><a href="/doing-the-work.html">Doing the Work</a></h2>
30+
<h2><a href="/development-guidelines.html">Development Guidelines (Conventions and Patterns)</a></h2>
3031
<h2><a href="/submitting-a-pull-request.html">Submitting a Pull Request</a></h2>
3132
<h2><a href="/responding-to-reviews.html">Responding to Reviews</a></h2>
3233
<h1>FAQ</h1>

0 commit comments

Comments
 (0)