portfolio-manager-go: Instructions file for GitHub Copilot

GitHub Copilot Instructions for portfolio-manager-go

Guidelines

• Whenever adding a new handler endpoint, always remember to add sample curl commands in README.md at the root. Also, if we change the directory structure, also remember to update the README on the Project Structure.
• Whenever adding a new handler endpoint, always update the swagger documentation for the endpoint (using swaggo comments above the handler).
• Whenever you amend config.yaml or add new configuration to config.go, always update the Configurations section in README.md to reflect the latest config options and defaults.
• When implementing getter methods that return collections (arrays/slices), always initialize with an empty collection ([]Type{}) rather than a nil slice to ensure JSON serialization produces an empty array ([]) instead of null. This maintains consistency with REST API best practices.
• Whenever testing and starting the server, don't check ./portfolio.log file for logs, instead check the output from the terminal where you started the server. The logs are printed to stdout/stderr, not to the log file.

Guidelines

• Always remember when building UI components that we support both dark and light themes. When choosing color scheme, make sure to account for both themes (preferbly via useMantineColorScheme) to ensure a consistent user experience.
• Whenever making calls to backend server from the front end, wrap the calls with getUrl function in web/ui/src/utils/url.ts

Mocking Strategy

When writing tests for this codebase (this only includes modules that are outside web/ui, i.e. non ui components), always use the testify mocking framework located in internal/mocks/testify/ rather than the custom mock implementations in internal/mocks/.

The testify mocking framework is the preferred approach for several reasons:

• It provides a more consistent and maintainable approach to mocking
• It has better support for verifying expectations and method calls
• It integrates well with the rest of our testing strategy