Skip to content

Commit f613ec9

Browse files
committed
chore(template): sync with dailydevops/template-dotnet [skip ci]
1 parent efc8ea1 commit f613ec9

File tree

4 files changed

+11
-44
lines changed

4 files changed

+11
-44
lines changed

decisions/2026-01-09-nuget-package-readme-template.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ The template provides a comprehensive structure including:
7070
* **Related Packages**: Cross-references to related packages in the ecosystem
7171
* **Documentation Links**: References to comprehensive documentation
7272
* **Contributing Guidelines**: Links to contribution processes
73-
* **Support Channels**: GitHub Issues, and documentation links
73+
* **Support Channels**: GitHub Issues and documentation links (GitHub Discussions is not used for project communication)
7474
* **License Information**: Clear license declaration and reference
7575

7676
All URLs in package READMEs MUST be absolute URLs pointing to GitHub or NuGet.org to ensure compatibility across all platforms where the README may be displayed.
@@ -158,3 +158,4 @@ Use automated documentation generation tools (DocFX, Sandcastle) instead of manu
158158

159159
* [English as Project Language](./2025-07-11-english-as-project-language.md) - All README content must be written in English following this decision
160160
* [Folder Structure and Naming Conventions](./2025-07-10-folder-structure-and-naming-conventions.md) - README files are placed at the root of each project directory following folder structure conventions
161+
* [No GitHub Discussions for Communication](./2025-11-01-no-github-discussions-for-communication.md) - GitHub Issues serve as the central point of contact for all project-related discussions

decisions/2026-01-10-standardized-solution-level-documentation.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,17 @@ Adopt a standardized template for solution-level README files (`templates/readme
4141

4242
The template includes:
4343

44-
1. **Standard Structure**: Overview, Projects, Features, Getting Started, Development, Architecture, Contributing, Code of Conduct, Documentation, Versioning, Support, License, Maintainers, and Acknowledgments sections
44+
1. **Standard Structure**: Overview, Projects, Features, Getting Started, Development, Architecture, Contributing, Code of Conduct, Documentation, Versioning, Support, and License sections
4545
2. **Relative Links**: All internal references use relative paths (e.g., `[CONTRIBUTING.md](CONTRIBUTING.md)`)
4646
3. **Inline Guidance**: HTML comments provide detailed instructions for each section
4747
4. **Badge Support**: Standardized badges for license, build status, and contributors
4848
5. **Placeholder Patterns**: Consistent use of `YourRepo`, `ProjectName`, and similar placeholders for easy customization
49-
6. **Flexible Structure**: Optional sections (Maintainers, Acknowledgments, Configuration) can be removed if not needed
49+
6. **Flexible Structure**: Optional sections (Acknowledgments, Configuration) can be removed if not needed
5050
7. **Marker Preservation**: Support for preserving existing content markers (e.g., `<!-- packages:start -->`, `<!-- packages:end -->`) during modernization
51-
8. **GitVersion Integration**: Documents the use of automated semantic versioning
52-
9. **Conventional Commits Reference**: Links to commit message standards
53-
10. **ADR Integration**: References Architecture Decision Records with relative links to `decisions/` folder
51+
8. **Support Communication**: Directs users to GitHub Issues as the central point of contact (GitHub Discussions is not used)
52+
9. **GitVersion Integration**: Documents the use of automated semantic versioning
53+
10. **Conventional Commits Reference**: Links to commit message standards
54+
11. **ADR Integration**: References Architecture Decision Records with relative links to `decisions/` folder
5455

5556
When modernizing existing README files:
5657
* MUST preserve all existing content markers (comments like `<!-- packages:start -->`)
@@ -145,3 +146,4 @@ When modernizing existing README files:
145146
* [English as Project Language](./2025-07-11-english-as-project-language.md) - Establishes language requirements for all documentation
146147
* [GitVersion Automated Semantic Versioning](./2025-07-10-gitversion-automated-semantic-versioning.md) - Referenced in the Versioning section of the template
147148
* [Conventional Commits](./2025-07-10-conventional-commits.md) - Referenced in Contributing and Versioning sections
149+
* [No GitHub Discussions for Communication](./2025-11-01-no-github-discussions-for-communication.md) - GitHub Issues serve as the central point of contact for all project discussions

templates/readme-project.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ Contributions are welcome! Please read the [Contributing Guidelines](https://git
160160

161161
## Support
162162

163-
<!-- Replace 'YourRepo' with the actual repository name in all links below. -->
163+
<!-- Replace 'YourRepo' with the actual repository name in all links below. All communication related to bugs, features, and project coordination occurs through GitHub Issues. -->
164164
* **Issues**: Report bugs or request features on [GitHub Issues](https://github.com/dailydevops/YourRepo/issues)
165165
* **Documentation**: Read the full documentation at [https://github.com/dailydevops/YourRepo](https://github.com/dailydevops/YourRepo)
166166

@@ -169,17 +169,6 @@ Contributions are welcome! Please read the [Contributing Guidelines](https://git
169169
<!-- Replace 'MIT License' and 'YourRepo' with actual values. Ensure the LICENSE file exists in the repository. -->
170170
This project is licensed under the MIT License - see the [LICENSE](https://github.com/dailydevops/YourRepo/blob/main/LICENSE) file for details.
171171

172-
## Acknowledgments
173-
174-
<!--
175-
Optional: Credit contributors, libraries, or resources that helped with this project.
176-
Remove this section if not needed.
177-
Examples:
178-
- Thank specific contributors or organizations
179-
- Credit libraries or tools used
180-
- Acknowledge inspiration or related projects
181-
-->
182-
183172
---
184173

185174
> [!NOTE]

templates/readme-solution.md

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,7 @@ This project uses [GitVersion](https://gitversion.net/) for automated semantic v
256256
<!--
257257
Provide information on how users can get help or report issues.
258258
Replace 'YourRepo' with actual repository name.
259+
All communication related to bugs, features, and project coordination occurs through GitHub Issues.
259260
-->
260261

261262
* **Issues**: Report bugs or request features on [GitHub Issues](https://github.com/dailydevops/YourRepo/issues)
@@ -270,32 +271,6 @@ Replace 'MIT License' with actual license type if different.
270271

271272
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
272273

273-
## Maintainers
274-
275-
<!--
276-
Optional: List the primary maintainers or teams responsible for this solution.
277-
Include contact information or GitHub handles.
278-
Remove this section if not needed.
279-
-->
280-
281-
* **Team Name** - [@githubhandle](https://github.com/githubhandle)
282-
* **Individual Name** - [@githubhandle](https://github.com/githubhandle)
283-
284-
## Acknowledgments
285-
286-
<!--
287-
Optional: Credit contributors, libraries, or resources that helped with this solution.
288-
Remove this section if not needed.
289-
Examples:
290-
- Thank specific contributors or organizations
291-
- Credit important libraries or frameworks used
292-
- Acknowledge inspiration or related projects
293-
-->
294-
295-
* Special thanks to all [contributors](https://github.com/dailydevops/YourRepo/graphs/contributors)
296-
* Built with [.NET](https://dotnet.microsoft.com/)
297-
* Inspired by community best practices and patterns
298-
299274
---
300275

301276
> [!NOTE]

0 commit comments

Comments
 (0)