Skip to content

Commit d52c0e7

Browse files
hassanhabibhassanhabib
authored
Merge pull request #21 from glhays/users/glhays/documentation-categoieslist-updated
DOCUMENTATION: Category List Update
2 parents cf2b94c + 9998b6b commit d52c0e7

File tree

1 file changed

+85
-38
lines changed

1 file changed

+85
-38
lines changed

‎4 Practices/4 Practices.md‎

Lines changed: 85 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -88,44 +88,91 @@ The variables can be subsituted
8888

8989
### 4.1.1.3 Category List
9090

91-
| Category | Description |
92-
| -------------- | ----------- |
93-
| INFRA | Initial project setup, creating the build project / build scripts. |
94-
| MINOR INFRA | Minor updates, removing or adding simple configurations or files. |
95-
| MEDIUM INFRA | Medium updates, removing or adding simple configurations or files. |
96-
| MAJOR INFRA | Major updates, removing or adding simple configurations or files. |
97-
| PROVISIONS | Creating your provions project / scripts. |
98-
| RELEASES | Infrastructure work to release software. |
99-
| DATA | Creation of a data model (and its migration when EF is used) |
100-
| BROKERS | When creating brokers to wrap external libraries, resources, services, or APIs |
101-
| FOUNDATIONS | When creating Foundation Services |
102-
| PROCESSINGS | When creating Processing Services |
103-
| ORCHESTRATIONS | When creating Orchestration Services |
104-
| COORDINATIONS | When creating Coordination Services |
105-
| MANAGEMENTS | When creating Management Services |
106-
| AGGREGATIONS | When creating Aggregation Services |
107-
| CONTROLLERS | When creating an exposer like a REST API |
108-
| CLIENTS | When creating an exposer on a library that others can use |
109-
| PROVIDERS | When creating an exposer on a SPAL provider library that others can use |
110-
| EXPOSERS | When creating any other kind of exposer i.e. Program.cs |
111-
| BASE | When creating frontend base components |
112-
| COMPONENTS | When creating component |
113-
| VIEWS | When working on views |
114-
| PAGES | When creating Blazor pages |
115-
| ACCEPTANCE | When writing Acceptance Tests |
116-
| INTEGRATIONS | When writing Integration Tests |
117-
| CODE RUB | Small change to fix things styling, code formatting, spelling (Not for bug fixes) |
118-
| MINOR FIX | A minor bug fix / change that do not significantly alter the overall functionality of the program. |
119-
| MEDIUM FIX | A fix that has a moderate level of impact on the functionality or performance of a program or system. It may cause some inconvenience or minor disruption to the user experience, but it is not critical and can typically be resolved with a moderate amount of effort. |
120-
| MAJOR FIX | A major bug fix is a significant repair or correction made to a software program or system that addresses a critical or major issue that is preventing the program or system from functioning correctly. This type of bug fix is typically classified as high priority, as it affects the overall functionality and usability of the program or system, and can have a significant impact on the user experience. Major bug fixes often require extensive testing and validation before they can be released. |
121-
| DOCUMENTATION | General documentation |
122-
| CONFIG | Any configuration changes i.e. setting up appsettings.json for your various environments. |
123-
| STANDARD | When you update or introduce a new thing in The Standard |
124-
| DESIGN | Creating doumentation has design details for your architecture (High Level Design / Low Level Design) |
125-
| BUSINESS | Creating documentation that outlines your business processes / Standard Operating Procedures. Work required to bring the customer to use your software. |
126-
| IMPORT | When you are copying code and tests over from another system with no or minor changes like namepsaces |
127-
| STATUS | When updating STATUS information in your design documentation i.e. changing milestone color indicators from black or red to orange to green OR changing text indcators NOT STARTED / IN PROGRESS / BLOCKED / COMPLETED |
128-
| MENTORSHIP | When conducting a meeting under the MENTORSHIP title, the developer is responsible for teaching others or assisting in problem-solving. These sessions focus on knowledge sharing, skill development, and collaborative troubleshooting. Points are calculated based on the duration of the session per hour. |
91+
| Category | Description |
92+
| -------------- | ----------- |
93+
| INFRA | Initial project setup, creating the build project / build scripts. |
94+
| MAJOR INFRA | Major updates, removing or adding simple configurations or files. |
95+
| MEDIUM INFRA | Medium updates, removing or adding simple configurations or files. |
96+
| MINOR INFRA | Minor updates, removing or adding simple configurations or files. |
97+
| PROVISIONS | Creating provision project / scripts. |
98+
| RELEASES | Infrastructure work to release software. |
99+
| DATA | Creation of a data model (and its migration when EF is used) |
100+
| BROKERS | When creating brokers to wrap external libraries, resources, services, or APIs |
101+
| MAJOR BROKERS | |
102+
| MEDIUM BROKERS | |
103+
| MINOR BROKERS | |
104+
| FOUNDATIONS | When creating Foundation Services |
105+
| MAJOR FOUNDATIONS | |
106+
| MEDIUM FOUNDATIONS | |
107+
| MINOR FOUNDATIONS | |
108+
| PROCESSINGS | When creating Processing Services |
109+
| MAJOR PROCESSINGS | |
110+
| MEDIUM PROCESSINGS | |
111+
| MINOR PROCESSINGS | |
112+
| ORCHESTRATIONS | When creating Orchestration Services |
113+
| MAJOR ORCHESTRATIONS | |
114+
| MEDIUM ORCHESTRATIONS | |
115+
| MINOR ORCHESTRATIONS | |
116+
| COORDINATIONS | When creating Coordination Services |
117+
| MAJOR COORDINATIONS | |
118+
| MEDIUM COORDINATIONS | |
119+
| MINOR COORDINATIONS | |
120+
| MANAGEMENTS | When creating Management Services |
121+
| MAJOR MANAGEMENTS | |
122+
| MEDIUM MANAGEMENTS | |
123+
| MINOR MANAGEMENTS | |
124+
| AGGREGATIONS | When creating Aggregation Services |
125+
| MAJOR AGGREGATIONS | |
126+
| MEDIUM AGGREGATIONS | |
127+
| MINOR AGGREGATIONS | |
128+
| CONTROLLERS | When creating an exposer like a REST API |
129+
| MAJOR CONTROLLERS | |
130+
| MEDIUM CONTROLLERS | |
131+
| MINOR CONTROLLERS | |
132+
| CLIENTS | When creating an exposer on a library that others can use |
133+
| PROVIDERS | When creating an exposer on a SPAL provider library that others can use |
134+
| EXPOSERS | When creating any other kind of exposer i.e. Program.cs |
135+
| BASES | When creating frontend base components |
136+
| MAJOR BASES | |
137+
| MEDIUM BASES | |
138+
| MINOR BASES | |
139+
| COMPONENTS | When creating components |
140+
| MAJOR COMPONENTS | |
141+
| MEDIUM COMPONENTS | |
142+
| MINOR COMPONENTS | |
143+
| VIEWS | When creating views |
144+
| MAJOR VIEWS | |
145+
| MEDIUM VIEWS | |
146+
| MINOR VIEWS | |
147+
| PAGES | When creating Blazor pages |
148+
| MAJOR PAGES | |
149+
| MEDIUM PAGES | |
150+
| MINOR PAGES | |
151+
| ACCEPTANCE | When writing Acceptance tests |
152+
| MAJOR ACCEPTANCE | |
153+
| MEDIUM ACCEPTANCE | |
154+
| MINOR ACCEPTANCE | |
155+
| INTEGRATIONS | When writing Integration Tests |
156+
| CODE RUB | Small change to fix things styling, code formatting, spelling (Not for bug fixes) |
157+
| MAJOR CODE RUB | |
158+
| MEDIUM CODE RUB | |
159+
| MINOR CODE RUB | |
160+
| MINOR FIX | A minor bug fix / change that do not significantly alter the overall functionality of the program. |
161+
| MEDIUM FIX | A fix that has a moderate level of impact on the functionality or performance of a program or system. It may cause some inconvenience or minor disruption to the user experience, but it is not critical and can typically be resolved with a moderate amount of effort. |
162+
| MAJOR FIX | A major bug fix is a significant repair or correction made to a software program or system that addresses a critical or major issue that is preventing the program or system from functioning correctly. This type of bug fix is typically classified as high priority, as it affects the overall functionality and usability of the program or system, and can have a significant impact on the user experience. Major bug fixes often require extensive testing and validation before they can be released. |
163+
| DOCUMENTATION | General documentation |
164+
| CONFIG | Any configuration changes i.e. setting up appsettings.json for your various environments. |
165+
| REVIEW | Reviewing submitted work in the context of project standards, and Standard compliance. |
166+
| STANDARD | When you update or introduce a new thing in The Standard |
167+
| DESIGN | Creating documentation has design details for your architecture (High Level Design / Low Level Design) |
168+
| MAJOR DESIGN | |
169+
| MEDIUM DESIGN | |
170+
| MINOR DESIGN | |
171+
| BUSINESS | Creating documentation that outlines your business processes / Standard Operating Procedures. Work required to bring the customer to use your software. |
172+
| IMPORT | When you are copying code and tests over from another system with no or minor changes like namepsaces |
173+
| STATUS | When updating STATUS information in your design documentation i.e. changing milestone color indicators from black or red to orange to green OR changing text indcators NOT STARTED / IN PROGRESS / BLOCKED / COMPLETED |
174+
| MENTORSHIP | When conducting a meeting under the MENTORSHIP title, the developer is responsible for teaching others or assisting in problem-solving. These sessions focus on knowledge sharing, skill development, and collaborative troubleshooting. Points are calculated based on the duration of the session per hour. |
175+
| DISCUSSION | When conducting a discussion meeting, surrounding technical issues. Points are calculated based on the duration of the session per hour. |
129176

130177
### 4.1.2 Projects
131178

0 commit comments

Comments
 (0)