Skip to content

Commit 66bb34c

Browse files
committed
Adding backlinks
1 parent 2320298 commit 66bb34c

16 files changed

+63
-22
lines changed

docs/ADR/CreatingMocks.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,7 @@ Mocks will be created using a mock factory. The mock factory will provide a cent
2020

2121
- **Complexity**: Introduces an additional layer of abstraction, which may add some complexity to the framework.
2222
- **Maintenance**: Requires ongoing maintenance to ensure the mock factory remains up-to-date with any changes to the framework.
23+
24+
---
25+
26+
More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.

docs/ADR/DoWeNeedANewMockingFramework.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,7 @@ We will develop a new mocking framework, MiniMock, that focuses on providing a m
2222
- **Feature Limitations**: The framework may lack some advanced features found in more comprehensive mocking frameworks.
2323
- **Development Effort**: Additional effort will be required to develop and maintain the new framework.
2424
- **Adoption**: Convincing developers to switch to a new framework may be challenging, especially if they are accustomed to existing solutions.
25+
26+
---
27+
28+
More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.

docs/ADR/DocumentationAndExamples.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,7 @@ Accepted
3939
- **Basic Mocking**: Simple example showing how to create and use a mock.
4040
- **Advanced Mocking**: Examples of more complex scenarios, such as mocking protected methods and handling asynchronous methods.
4141
- **Integration**: Examples showing how to integrate the framework with other tools and libraries.
42+
43+
---
44+
45+
More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.

docs/ADR/HowStrictShouldMiniMockBe.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,7 @@ The framework will be strict, throwing exceptions when a member that is not mock
2020

2121
- **Strictness**: The strict approach may require more effort to set up mocks, as all interactions must be explicitly defined.
2222
- **Event Handling**: Special handling for events may introduce some complexity in the framework.
23+
24+
---
25+
26+
More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.

docs/ADR/LoggingAndDebugging.md

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,6 @@ Accepted
3030
1. **Logging**: Plan and design the logging mechanism to capture mock setup events and calls to mocks.
3131
2. **DebuggerStepThrough**: Apply the `DebuggerStepThrough` attribute to relevant methods and classes to improve the debugging experience.
3232

33-
## Example
34-
35-
```csharp
36-
[System.Diagnostics.DebuggerStepThrough]
37-
public void SetupMock()
38-
{
39-
// Setup mock logic
40-
Log("Mock setup completed.");
41-
}
42-
43-
[System.Diagnostics.DebuggerStepThrough]
44-
public void CallMock()
45-
{
46-
// Call mock logic
47-
Log("Mock method called.");
48-
}
49-
50-
private void Log(string message)
51-
{
52-
// Placeholder for logging implementation
53-
Console.WriteLine(message);
54-
}
33+
---
34+
35+
More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.

docs/ADR/MatchingTargetApi.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,7 @@ Accepted
2020
### Negative:
2121
- Limited flexibility in extending the mock API for advanced testing scenarios.
2222
- May require more effort to implement certain mocking features without additional methods.
23+
24+
---
25+
26+
More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.

docs/ADR/NoBuiltInAssertionFeature.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,7 @@ We will not include a built-in assertion feature in our mocking framework. Inste
2020

2121
- **Learning Curve**: Users may need to learn and integrate a separate assertion framework if they are not already familiar with one.
2222
- **Dependency Management**: Users will need to manage additional dependencies for their chosen assertion framework.
23+
24+
---
25+
26+
More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.

docs/ADR/NoDependencies.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,7 @@ We will not include any dependencies on shared libraries in our project. Instead
2222
- **Development Effort**: May require additional effort to implement functionality that would otherwise be provided by shared libraries.
2323
- **Code Duplication**: Potential for code duplication if similar functionality is needed across multiple projects.
2424
- **Maintenance**: Increased maintenance burden as all functionality must be maintained within the project.
25+
26+
---
27+
28+
More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.

docs/ADR/SupportSkippingArguments.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,7 @@ We will allow the skipping of arguments when setting up mocks for methods. This
1919
- **Clarity**: May reduce the clarity of tests if arguments are skipped without proper documentation.
2020
- **Consistency**: Could lead to inconsistent mock setups across the codebase if not used judiciously.
2121
- **Error Potential**: Increases the risk of errors if skipped arguments are assumed incorrectly.~~~~
22+
23+
---
24+
25+
More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.

docs/ADR/feature/SupportForClassesAndInterfaces.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,7 @@ The MiniMock framework will primarily focus on supporting interfaces but will al
2121
- **Complexity**: Adding support for classes may introduce additional complexity in the framework.
2222
- **Maintenance**: Requires ongoing maintenance to ensure both interfaces and classes are supported effectively.
2323
f mocking scenarios.
24+
25+
---
26+
27+
More ADRs can be found in the [docs/ADR](../README.md) directory.

0 commit comments

Comments
 (0)