-
-
Notifications
You must be signed in to change notification settings - Fork 54
Add streamlined project documentation and contributing guide #659
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
- Add detailed project structure documentation (docs/PROJECT_STRUCTURE.md) - Add comprehensive contributing guide (docs/CONTRIBUTING.md) - Add documentation index (docs/README.md) - Update main README.md with contributor resources - Include development environment setup, build instructions, code guidelines - Document MVVM patterns, architecture, and technology stack - Include translation workflow and submission process Co-authored-by: huynhsontung <[email protected]>
- Add additional community resources (releases, store links) - Include contribution paths for non-developers - Improve guidance for translators and testers - Polish documentation index structure Co-authored-by: huynhsontung <[email protected]>
Yeah, I think I prefer this over the Wiki, though we should drop the extra |
Yes with emojis. Emojis are hip. You can ask Copilot to refine it 😉 |
@copilot Too much friction. First remove the extra Move the The Getting Started prerequisites should only mention the Visual Studio 2022 or later (JetBrains Rider should also work but I don't know setup there) with the 'WinUI application development' workload installed, with the optional 'Universal Windows Platform tools' and 'Windows 11 SDK (10.0.22621)' checked. Keep the Windows minimum version. Shorten the Development Environment Setup section, focus only on forking the repository, opening the solution, and building it for the first time to restore NuGet packages. BTW Visual Studio built-in Git integration should be sufficient, no need to reference other tools or methods. I wonder if we could get by with the Project structure section and removing the Consider removing the Code Guidelines section. Instead, just remind users to run the XAML Styler on Testing section is fine, maybe the "Test on different platforms: x64, x86, ARM64 if possible" is a bit too much. Also the accessibility should be more comprehensive, include test with different themes (also high contrast), screen scale, text scale factor and gamepad if possible. The Translation section should focus primarily on how to create and add new strings (i.e. only add new resources to the And finally for the Submitting Contributions section, streamline it by removing unnecessary details like addressing feedback and requirements, we want minimal friction. Remove ResX Resource Manager from the Resources section, it's no longer needed. |
- Remove extra docs/README.md file - Move CONTRIBUTING.md to repository root - Simplify CONTRIBUTING.md by removing excessive information - Add emojis as requested - Remove ResX Resource Manager references - Update README.md links to reflect new structure Co-authored-by: United600 <[email protected]>
I've addressed all your feedback in commit ad2fa73: ✅ Removed the extra README.md from docs folder The CONTRIBUTING.md is now much leaner (went from ~12KB to ~6KB) while keeping PROJECT_STRUCTURE.md available for the detailed architecture info. |
@copilot Better, but I can identify a couple of errors or omissions. The 'Universal Windows Platform tools' and 'Windows 11 SDK (10.0.22621)' are required, they are marked as optional within the 'WinUI application development' workload, but should be checked. We also forgot to mention that Developer mode must be enabled in Windows settings. Cloning the fork can be done directly in Visual Studio, which is much easier. The plataform on the "Set the platform to x64 and start debugging: F5" should match the architecture of user machine. There are quite a few Git commands here, which might feel overwhelming for less experienced contributors or those who aren’t yet familiar with Git. There should be a link to the For pull request titles, consider using most of the prefixes outlined in the Conventional Commits standard, as they align well with our current approach. The EditorConfig subsection is just not good, remove it and keep the "Your IDE should automatically apply these rules when the .editorconfig file is present.", will need some changes since you're removing the rules. The Local Translation point needs improvement. For guidance, refer to the |
Co-authored-by: United600 <[email protected]>
Fixed all the issues you identified in commit e98d16e: ✅ Prerequisites corrected - Universal Windows Platform tools and Windows 11 SDK are now marked as required, and added Developer mode requirement The CONTRIBUTING.md is now much more accurate and user-friendly while maintaining all the technical requirements. |
This is good enough :) |
What's Fixed
🔧 Prerequisites Corrections
🛠️ Development Setup Improvements
📝 Documentation Enhancements
🧹 Content Cleanup
The CONTRIBUTING.md is now more accurate, easier to follow, and properly addresses the technical requirements while maintaining minimal friction for new contributors.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.