Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 21, 2025

  • Add streamlined project documentation and contributing guide
  • Move CONTRIBUTING.md to repository root
  • Remove extra README.md from docs folder
  • Streamline Getting Started section with correct prerequisites
  • Simplify Development Environment Setup
  • Clean up Development Workflow with correct PR guidelines
  • Replace detailed Code Guidelines with simple formatting instructions
  • Improve Testing section with comprehensive accessibility testing
  • Focus Translation section on adding new strings to .en-US.resw files
  • Remove ResX Resource Manager references
  • Add emojis throughout as requested
  • Fix Universal Windows Platform tools and Windows 11 SDK as required components
  • Add Developer mode requirement to Windows settings
  • Update cloning instructions to mention Visual Studio option
  • Fix platform selection guidance to match user's machine architecture
  • Simplify Git workflow for less experienced contributors
  • Add link to PROJECT_STRUCTURE.md in Project Structure section
  • Update PR titles to reference Conventional Commits standard
  • Remove detailed EditorConfig subsection
  • Improve Local Translation workflow with README reference

What's Fixed

🔧 Prerequisites Corrections

  • Made Universal Windows Platform tools and Windows 11 SDK required (not optional)
  • Added Developer mode requirement for Windows settings
  • Clarified that these components must be checked during Visual Studio installation

🛠️ Development Setup Improvements

  • Added Visual Studio cloning option as the easier method
  • Updated platform selection to "match your machine's architecture (typically x64)"
  • Simplified Git workflow to reduce overwhelm for new contributors

📝 Documentation Enhancements

  • Added direct link to PROJECT_STRUCTURE.md in the Project Structure section
  • Updated PR title guidelines to reference Conventional Commits standard
  • Streamlined EditorConfig section to just mention automatic rule application
  • Enhanced Local Translation workflow with proper README.md references and language tag guidance

🧹 Content Cleanup

  • Removed misplaced code snippets that appeared in the Testing section
  • Reduced Git command complexity for better accessibility
  • Focused translation guidance on languages not available on Crowdin

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.

Copilot AI and others added 2 commits August 21, 2025 00:54
- 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]>
@Copilot Copilot AI changed the title [WIP] Document the project structure, and come up with a contributing guide page for new contributors. Use the existing Project Walkthrough wiki as a reference. Improve and expand upon it. Add comprehensive project documentation and contributing guide Aug 21, 2025
@Copilot Copilot AI requested a review from huynhsontung August 21, 2025 00:57
Copilot finished work on behalf of huynhsontung August 21, 2025 00:57
@huynhsontung huynhsontung requested a review from United600 August 21, 2025 00:58
@United600
Copy link
Collaborator

Yeah, I think I prefer this over the Wiki, though we should drop the extra README.md.
The CONTRIBUTING.md is filled with too much unnecessary info and steps. Same for the PROJECT_STRUCTURE.md, but I like it, it reminds me of the one from the Calculator repository.
Needs a few tweaks, I’ll try to review it more closely over the weekend.
Ah, emojis? Yes or no?

@huynhsontung
Copy link
Owner

Yes with emojis. Emojis are hip. You can ask Copilot to refine it 😉

@United600
Copy link
Collaborator

@copilot Too much friction. First remove the extra README.md.

Move the CONTRIBUTING.md to the repository root, and there is too much fluff and superfluous info (even totally wrong info).

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 PROJECT_STRUCTURE.md file, let's keep it for now.
The Development Workflow is filled with fluff and wrong info, for example the commits prefixes are for pull requests.

Consider removing the Code Guidelines section. Instead, just remind users to run the XAML Styler on .xaml files and use the Code Cleanup feature (Ctrl+K, Ctrl+E) on .cs files before committing changes. Or simply highlight some of the .editorconfig rules.

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 .en-US.resw files), maybe even include how we use ReswPlus features to support pluralization and more.

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]>
Copy link
Contributor Author

Copilot AI commented Sep 7, 2025

@copilot Too much friction. First remove the extra README.md.

Move the CONTRIBUTING.md to the repository root, and there is too much fluff and superfluous info (even totally wrong info).
...

I've addressed all your feedback in commit ad2fa73:

Removed the extra README.md from docs folder
Moved CONTRIBUTING.md to repository root
Streamlined Getting Started - now only mentions Visual Studio 2022+ with 'WinUI application development' workload and optional 'Universal Windows Platform tools' + 'Windows 11 SDK (10.0.22621)'
Simplified Development Environment Setup - focuses only on forking, opening solution, and building to restore NuGet packages using VS built-in Git
Cleaned up Development Workflow - removed incorrect commit prefix info and other fluff
Replaced detailed Code Guidelines - now just reminds to run XAML Styler on .xaml files and Code Cleanup (Ctrl+K, Ctrl+E) on .cs files, with reference to .editorconfig rules
Improved Testing section - removed platform testing requirement, added comprehensive accessibility testing (themes, high contrast, screen scale, text scale factor, gamepad)
Focused Translation section - emphasizes adding new strings only to .en-US.resw files and mentions ReswPlus features for pluralization
Streamlined Submitting Contributions - removed unnecessary details about feedback and requirements
Removed ResX Resource Manager from both CONTRIBUTING.md and main README.md
Added emojis throughout as requested by @huynhsontung

The CONTRIBUTING.md is now much leaner (went from ~12KB to ~6KB) while keeping PROJECT_STRUCTURE.md available for the detailed architecture info.

@Copilot Copilot AI changed the title Add comprehensive project documentation and contributing guide Add streamlined project documentation and contributing guide Sep 7, 2025
Copilot finished work on behalf of United600 September 7, 2025 21:30
@United600
Copy link
Collaborator

@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 PROJECT_STRUCTURE.md file somewhere in the Project Structure section.

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 README.md, especially the language tags, and note that local translation should only be recommended for languages not available on Crowdin.

Copy link
Contributor Author

Copilot AI commented Sep 7, 2025

@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 'W...

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
Visual Studio cloning option - Added easier cloning method directly in Visual Studio
Platform selection fixed - Now says "match your machine's architecture (typically x64)"
Simplified Git workflow - Removed overwhelming Git commands for better accessibility
Added PROJECT_STRUCTURE.md link - Direct link added in the Project Structure section
Conventional Commits reference - Updated PR title guidelines to reference the standard
EditorConfig streamlined - Removed detailed subsection, kept simple .editorconfig reference
Local Translation improved - Added README.md reference and clarified it's only for languages not on Crowdin
Content cleanup - Removed misplaced code snippets and reduced complexity

The CONTRIBUTING.md is now much more accurate and user-friendly while maintaining all the technical requirements.

Copilot finished work on behalf of United600 September 7, 2025 22:04
@huynhsontung
Copy link
Owner

This is good enough :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants