Skip to content

Commit 53f2791

Browse files
committed
chore(template): sync with dailydevops/template-dotnet [skip ci]
1 parent 63ca9e6 commit 53f2791

File tree

2 files changed

+44
-38
lines changed

2 files changed

+44
-38
lines changed

templates/readme-project.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,4 +179,4 @@ This project is licensed under the MIT License - see the [LICENSE](https://githu
179179

180180
> [!NOTE]
181181
> **Made with ❤️ by the NetEvolve Team**
182-
> Visit us at [https://www.netevolve.com](https://www.netevolve.com) for more information about our services and solutions.
182+
> Visit us at [https://www.daily-devops.net](https://www.daily-devops.net) for more information about our services and solutions.

templates/readme-solution.md

Lines changed: 43 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ Include information about the technical stack, frameworks, and key technologies
2626

2727
This solution contains multiple projects organized into a cohesive architecture:
2828

29-
* **Core Projects**: Foundation libraries and shared abstractions
30-
* **Service Projects**: Business logic and domain services
31-
* **Integration Projects**: External system integrations and adapters
32-
* **Test Projects**: Comprehensive unit and integration tests
29+
- **Core Projects**: Foundation libraries and shared abstractions
30+
- **Service Projects**: Business logic and domain services
31+
- **Integration Projects**: External system integrations and adapters
32+
- **Test Projects**: Comprehensive unit and integration tests
3333

3434
## Projects
3535

@@ -42,23 +42,23 @@ Replace example entries with actual projects.
4242

4343
### Core Libraries
4444

45-
* **ProjectName.Core** - Core domain models, interfaces, and shared utilities
46-
* **ProjectName.Abstractions** - Public contracts and abstractions for extensibility
45+
- **ProjectName.Core** - Core domain models, interfaces, and shared utilities
46+
- **ProjectName.Abstractions** - Public contracts and abstractions for extensibility
4747

4848
### Services
4949

50-
* **ProjectName.Services** - Business logic implementation and service layer
51-
* **ProjectName.Api** - RESTful API endpoints and controllers
50+
- **ProjectName.Services** - Business logic implementation and service layer
51+
- **ProjectName.Api** - RESTful API endpoints and controllers
5252

5353
### Infrastructure
5454

55-
* **ProjectName.Data** - Data access layer and repository implementations
56-
* **ProjectName.Infrastructure** - Cross-cutting concerns and infrastructure services
55+
- **ProjectName.Data** - Data access layer and repository implementations
56+
- **ProjectName.Infrastructure** - Cross-cutting concerns and infrastructure services
5757

5858
### Tests
5959

60-
* **ProjectName.Tests.Unit** - Unit tests for all core components
61-
* **ProjectName.Tests.Integration** - Integration tests and end-to-end scenarios
60+
- **ProjectName.Tests.Unit** - Unit tests for all core components
61+
- **ProjectName.Tests.Integration** - Integration tests and end-to-end scenarios
6262

6363
## Features
6464

@@ -69,10 +69,10 @@ Start each feature with a strong action verb or noun.
6969
Limit to 6-10 key features to maintain focus.
7070
-->
7171

72-
* Feature 1 - Brief description of solution-wide capability
73-
* Feature 2 - Brief description of solution-wide capability
74-
* Feature 3 - Brief description of solution-wide capability
75-
* Feature 4 - Brief description of solution-wide capability
72+
- Feature 1 - Brief description of solution-wide capability
73+
- Feature 2 - Brief description of solution-wide capability
74+
- Feature 3 - Brief description of solution-wide capability
75+
- Feature 4 - Brief description of solution-wide capability
7676

7777
## Getting Started
7878

@@ -85,10 +85,10 @@ Mention any system requirements (OS, hardware, etc.).
8585
Replace version numbers with actual requirements.
8686
-->
8787

88-
* [.NET SDK 10.0](https://dotnet.microsoft.com/download) or higher
89-
* [Git](https://git-scm.com/) for version control
90-
* [Visual Studio 2022](https://visualstudio.microsoft.com/) or [Visual Studio Code](https://code.visualstudio.com/) (recommended)
91-
* Any additional tools or dependencies
88+
- [.NET SDK 10.0](https://dotnet.microsoft.com/download) or higher
89+
- [Git](https://git-scm.com/) for version control
90+
- [Visual Studio 2022](https://visualstudio.microsoft.com/) or [Visual Studio Code](https://code.visualstudio.com/) (recommended)
91+
- Any additional tools or dependencies
9292

9393
### Installation
9494

@@ -99,22 +99,26 @@ Replace 'YourRepo' with actual repository name.
9999
-->
100100

101101
1. Clone the repository:
102+
102103
```bash
103104
git clone https://github.com/dailydevops/YourRepo.git
104105
cd YourRepo
105106
```
106107

107108
2. Restore dependencies:
109+
108110
```bash
109111
dotnet restore
110112
```
111113

112114
3. Build the solution:
115+
113116
```bash
114117
dotnet build
115118
```
116119

117120
4. Run tests to verify installation:
121+
118122
```bash
119123
dotnet test
120124
```
@@ -175,7 +179,7 @@ Explain the folder structure and organization conventions.
175179
Help developers understand where different types of code should live.
176180
-->
177181

178-
```
182+
```txt
179183
src/ # Production code
180184
├── Core/ # Core libraries and abstractions
181185
├── Services/ # Business logic and services
@@ -200,10 +204,10 @@ Remove this section if not applicable.
200204

201205
This solution follows modern .NET architectural patterns and best practices:
202206

203-
* **Clean Architecture**: Clear separation of concerns with dependencies pointing inward
204-
* **Dependency Injection**: Built-in .NET dependency injection throughout
205-
* **Repository Pattern**: Abstraction over data access logic
206-
* **SOLID Principles**: Object-oriented design with SOLID principles
207+
- **Clean Architecture**: Clear separation of concerns with dependencies pointing inward
208+
- **Dependency Injection**: Built-in .NET dependency injection throughout
209+
- **Repository Pattern**: Abstraction over data access logic
210+
- **SOLID Principles**: Object-oriented design with SOLID principles
207211

208212
For detailed architectural decisions, see the [Architecture Decision Records](decisions/).
209213

@@ -217,18 +221,19 @@ Link to CONTRIBUTING.md for detailed guidelines.
217221
We welcome contributions from the community! Please read our [Contributing Guidelines](CONTRIBUTING.md) before submitting a pull request.
218222

219223
Key points:
220-
* Follow the [Conventional Commits](https://www.conventionalcommits.org/) format for commit messages
221-
* Write tests for new functionality
222-
* Follow existing code style and conventions
223-
* Update documentation as needed
224+
225+
- Follow the [Conventional Commits](https://www.conventionalcommits.org/) format for commit messages
226+
- Write tests for new functionality
227+
- Follow existing code style and conventions
228+
- Update documentation as needed
224229

225230
## Code of Conduct
226231

227232
<!--
228233
Reference the Code of Conduct to establish community standards.
229234
-->
230235

231-
This project adheres to the Contributor Covenant [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
236+
This project adheres to the Contributor Covenant [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]](mailto:[email protected]).
232237

233238
## Documentation
234239

@@ -237,10 +242,10 @@ Link to additional documentation resources.
237242
Include links to wikis, external docs sites, or specific documentation files.
238243
-->
239244

240-
* **[Architecture Decision Records](decisions/)** - Detailed architectural decisions and rationale
241-
* **[Contributing Guidelines](CONTRIBUTING.md)** - How to contribute to this project
242-
* **[Code of Conduct](CODE_OF_CONDUCT.md)** - Community standards and expectations
243-
* **[License](LICENSE)** - Project licensing information
245+
- **[Architecture Decision Records](decisions/)** - Detailed architectural decisions and rationale
246+
- **[Contributing Guidelines](CONTRIBUTING.md)** - How to contribute to this project
247+
- **[Code of Conduct](CODE_OF_CONDUCT.md)** - Community standards and expectations
248+
- **[License](LICENSE)** - Project licensing information
244249

245250
## Versioning
246251

@@ -259,8 +264,8 @@ Replace 'YourRepo' with actual repository name.
259264
All communication related to bugs, features, and project coordination occurs through GitHub Issues.
260265
-->
261266

262-
* **Issues**: Report bugs or request features on [GitHub Issues](https://github.com/dailydevops/YourRepo/issues)
263-
* **Documentation**: Read the full documentation in this repository
267+
- **Issues**: Report bugs or request features on [GitHub Issues](https://github.com/dailydevops/YourRepo/issues)
268+
- **Documentation**: Read the full documentation in this repository
264269

265270
## License
266271

@@ -273,5 +278,6 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
273278

274279
---
275280

276-
> [!NOTE]
281+
> [!NOTE]
277282
> **Made with ❤️ by the NetEvolve Team**
283+
> Visit us at [https://www.daily-devops.net](https://www.daily-devops.net) for more information about our services and solutions.

0 commit comments

Comments
 (0)