From e8d42f8696104f3152085f3212114d4703bbfed2 Mon Sep 17 00:00:00 2001 From: Peter Lasne Date: Tue, 3 Oct 2023 09:27:16 -0400 Subject: [PATCH] removed extra space --- docs/automated-testing/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/automated-testing/README.md b/docs/automated-testing/README.md index 0ca9da3fe9..32fca85235 100644 --- a/docs/automated-testing/README.md +++ b/docs/automated-testing/README.md @@ -64,7 +64,7 @@ The table below maps outcomes -- the results that you may want to achieve in you Testing is a critical part of the development process. It is important to build your application with testing in mind. Here are some tips to help you build for testing: -- **Parameterize everything.** Rather than hard-code any variables, consider making everything a configurable parameter with a reasonable default. This will allow you to easily change the behavior of your application during testing. Particularly during performance testing, it is common to test different values to see what impact that has on performance. If a range of defaults need to change together, consider one or more parameters which set "modes", changing the defaults of a group of parameters together. +- **Parameterize everything.** Rather than hard-code any variables, consider making everything a configurable parameter with a reasonable default. This will allow you to easily change the behavior of your application during testing. Particularly during performance testing, it is common to test different values to see what impact that has on performance. If a range of defaults need to change together, consider one or more parameters which set "modes", changing the defaults of a group of parameters together. - **Document at startup.** When your application starts up, it should log all parameters. This ensures the person reviewing the logs and application behavior know exactly how the application is configured. @@ -76,4 +76,4 @@ Testing is a critical part of the development process. It is important to build - **Correlate distributed activities.** If the system is performing some activity that is distributed across multiple systems, it is important to correlate the activity across those systems. This can be done using a Correlation ID that is passed from system to system. This allows someone reviewing the logs to understand the entire flow of activity. -- **Log metadata.** When logging, it is important to include metadata that is relevant to the activity. For example, a Tenant ID, Customer ID, or Order ID. This allows someone reviewing the logs to understand the context of the activity and filter to a manageable set of logs. \ No newline at end of file +- **Log metadata.** When logging, it is important to include metadata that is relevant to the activity. For example, a Tenant ID, Customer ID, or Order ID. This allows someone reviewing the logs to understand the context of the activity and filter to a manageable set of logs.