You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: decisions/2026-01-09-nuget-package-readme-template.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,7 +70,7 @@ The template provides a comprehensive structure including:
70
70
***Related Packages**: Cross-references to related packages in the ecosystem
71
71
***Documentation Links**: References to comprehensive documentation
72
72
***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)
74
74
***License Information**: Clear license declaration and reference
75
75
76
76
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
158
158
159
159
*[English as Project Language](./2025-07-11-english-as-project-language.md) - All README content must be written in English following this decision
160
160
*[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
1.**Standard Structure**: Overview, Projects, Features, Getting Started, Development, Architecture, Contributing, Code of Conduct, Documentation, Versioning, Support, and License sections
45
45
2.**Relative Links**: All internal references use relative paths (e.g., `[CONTRIBUTING.md](CONTRIBUTING.md)`)
46
46
3.**Inline Guidance**: HTML comments provide detailed instructions for each section
47
47
4.**Badge Support**: Standardized badges for license, build status, and contributors
48
48
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
50
50
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
54
55
55
56
When modernizing existing README files:
56
57
* MUST preserve all existing content markers (comments like `<!-- packages:start -->`)
@@ -145,3 +146,4 @@ When modernizing existing README files:
145
146
*[English as Project Language](./2025-07-11-english-as-project-language.md) - Establishes language requirements for all documentation
146
147
*[GitVersion Automated Semantic Versioning](./2025-07-10-gitversion-automated-semantic-versioning.md) - Referenced in the Versioning section of the template
147
148
*[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
Copy file name to clipboardExpand all lines: templates/readme-project.md
+1-12Lines changed: 1 addition & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -160,7 +160,7 @@ Contributions are welcome! Please read the [Contributing Guidelines](https://git
160
160
161
161
## Support
162
162
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. -->
164
164
***Issues**: Report bugs or request features on [GitHub Issues](https://github.com/dailydevops/YourRepo/issues)
165
165
***Documentation**: Read the full documentation at [https://github.com/dailydevops/YourRepo](https://github.com/dailydevops/YourRepo)
166
166
@@ -169,17 +169,6 @@ Contributions are welcome! Please read the [Contributing Guidelines](https://git
169
169
<!-- Replace 'MIT License' and 'YourRepo' with actual values. Ensure the LICENSE file exists in the repository. -->
170
170
This project is licensed under the MIT License - see the [LICENSE](https://github.com/dailydevops/YourRepo/blob/main/LICENSE) file for details.
171
171
172
-
## Acknowledgments
173
-
174
-
<!--
175
-
Optional: Credit contributors, libraries, or resources that helped with this project.
0 commit comments