Developer Resources

Project-Specific Workflows

Web Applications (React + ASP.NET)

Special considerations:

• Test both frontend and backend changes together
• Check browser console for errors
• Verify API contracts haven't broken
• Test responsiveness on different screen sizes
• Check database migrations if schema changed

PR checklist additions:

1. 1.Frontend builds without errors (`npm run build`)
2. 2.Backend builds without errors
3. 3.API endpoints tested (Postman, Swagger, or manual)
4. 4.Database migrations tested
5. 5.No console errors or warnings

Desktop Tools (WPF)

Special considerations:

• Test on multiple Windows versions if possible
• Check for memory leaks in long-running operations
• Verify file I/O operations don't block UI
• Test with large datasets if applicable

PR checklist additions:

1. 1.Application starts and closes cleanly
2. 2.No UI freezing during operations
3. 3.Settings persist correctly
4. 4.File operations handle errors gracefully

Libraries/Packages (C# Models)

Special considerations:

• These are used by other projects - breaking changes are critical
• Consider semantic versioning implications
• Document public APIs clearly
• Think about backward compatibility

PR checklist additions:

1. 1.XML documentation added for public members
2. 2.Breaking changes clearly marked
3. 3.Examples provided for new functionality
4. 4.Considered impact on dependent projects

Versioning:

• Patch (0.0.X): Bug fixes, no API changes
• Minor (0.X.0): New features, backward compatible
• Major (X.0.0): Breaking changes

Data Science Tools (Python, R)

Special considerations:

• Document data sources and assumptions
• Include example data or test cases
• Note Python/R version requirements
• Consider reproducibility

PR checklist additions:

1. 1.Required packages documented
2. 2.Example usage provided
3. 3.Data sources documented
4. 4.Results are reproducible