Contributing Guide

Thank you for your interest in contributing to DigYourWindows! This document will help you participate in project development.

Code of Conduct

• Respect all contributors
• Accept constructive criticism
• Focus on what is best for the community

How to Contribute

Reporting Bugs

1. Search Issues to confirm the bug hasn't been reported
2. Create a new Issue using the Bug report template
3. Include the following information:
   • Operating system version
   • .NET version
   • Steps to reproduce
   • Expected behavior vs actual behavior

Submitting Feature Requests

1. Create a new Issue using the Feature request template
2. Clearly describe the feature requirement and use case
3. Explain how the feature would benefit the project

Submitting Code

Development Environment Setup

# Clone the repository
git clone https://github.com/LessUp/dig-your-windows.git
cd dig-your-windows

# Restore dependencies
dotnet restore DigYourWindows.slnx

# Verify build
dotnet build DigYourWindows.slnx

# Run tests
dotnet test DigYourWindows.slnx

Code Standards

• Follow Microsoft C# Coding Conventions
• Use EditorConfig configuration (project includes .editorconfig)
• All public APIs must have XML documentation comments
• Unit tests use [MethodName]_[Scenario]_[ExpectedResult] naming format

Commit Convention

Use Conventional Commits format:

<type>(<scope>): <description>

[optional body]

[optional footer]

Types:

• feat: New feature
• fix: Bug fix
• docs: Documentation changes
• style: Code formatting (no functionality change)
• refactor: Code refactoring
• test: Test-related changes
• chore: Build/tooling changes

Examples:

feat(monitor): add GPU memory usage monitoring

fix(reliability): handle empty records in timeline builder

docs(guide): add troubleshooting section

Pull Request Process

1. Fork the repository and create a feature branch

   git checkout -b feat/my-feature

2. Make changes and write tests

3. Ensure all tests pass

   dotnet test DigYourWindows.slnx

4. Commit your changes

   git commit -m "feat: add amazing feature"

5. Push to your fork and create a Pull Request

6. Wait for CI to pass and code review

Pull Request Checklist

• [ ] Code follows project coding standards
• [ ] Necessary tests have been added
• [ ] All tests pass
• [ ] Documentation updated (if applicable)
• [ ] Commit messages follow Conventional Commits specification

Project Structure

dig-your-windows/
├── src/
│   ├── DigYourWindows.Core/   # Core business logic
│   └── DigYourWindows.UI/     # WPF user interface
├── tests/
│   └── DigYourWindows.Tests/  # Test project
├── docs/                      # VitePress documentation site
└── scripts/                   # Build scripts

Testing Guide

For detailed testing guide, refer to Testing Guide.

Running Tests

# Run all tests
dotnet test

# Run specific tests
dotnet test --filter "FullyQualifiedName~ReportServiceTests"

# Collect coverage
dotnet test --collect:"XPlat Code Coverage"

Release Process

1. Update version number in Directory.Build.props
2. Update CHANGELOG.md
3. Create and push Git tag

   git tag v1.x.x
   git push origin v1.x.x

4. GitHub Actions automatically builds and publishes

Getting Help

• Check the Documentation
• Ask in Discussions
• Create an Issue

License

This project is licensed under the MIT License. By submitting code, you agree that your contributions will be licensed under the same license.