Skip to content

Add Copilot instructions for repository conventions and architecture#124

Merged
Brogrammer1912 merged 3 commits intomainfrom
copilot/set-up-copilot-instructions
Dec 27, 2025
Merged

Add Copilot instructions for repository conventions and architecture#124
Brogrammer1912 merged 3 commits intomainfrom
copilot/set-up-copilot-instructions

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Dec 27, 2025

Configures GitHub Copilot coding agent instructions per best practices.

Changes

  • Created .github/copilot-instructions.md with:
    • Technology stack (Java 25, Spring Boot 3.5.7, Maven, H2, Thymeleaf, HTMX, Bt torrent library)
    • Package structure organized by feature/domain
    • Coding conventions: Lombok patterns (@RequiredArgsConstructor, @Slf4j), constructor injection with final fields
    • Naming patterns: *Controller, *Service, *Repository, *DTO
    • Spring Boot specifics: @Controller vs @RestController, GenerationType.IDENTITY, async/scheduling patterns
    • Build commands, configuration details, external API integrations (YTS, YouTube)
    • Reference to docs/tasks.md for architectural improvement backlog

Example Convention

@Controller
@RequiredArgsConstructor
public class WebController {
    final UserPreferences userPreferences;
    final WatchList watchList;
    
    @GetMapping("/")
    public String index(Model model) {
        // Controller logic
    }
}

Copilot will now provide context-aware suggestions aligned with the project's established patterns.

Original prompt

This section details on the original issue you should resolve

<issue_title>✨ Set up Copilot instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits December 27, 2025 13:43
Co-authored-by: Brogrammer1912 <89769614+Brogrammer1912@users.noreply.github.com>
Co-authored-by: Brogrammer1912 <89769614+Brogrammer1912@users.noreply.github.com>
Copilot AI changed the title [WIP] Configure instructions for Copilot in repository Add Copilot instructions for repository conventions and architecture Dec 27, 2025
Copilot AI requested a review from Brogrammer1912 December 27, 2025 13:46
Copy link
Copy Markdown
Owner

@Brogrammer1912 Brogrammer1912 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

@Brogrammer1912 Brogrammer1912 marked this pull request as ready for review December 27, 2025 13:57
Copilot AI review requested due to automatic review settings December 27, 2025 13:57
@Brogrammer1912 Brogrammer1912 merged commit 5f0ecf4 into main Dec 27, 2025
2 checks passed
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds comprehensive GitHub Copilot instructions to help the AI coding agent provide context-aware suggestions aligned with the StreamSpace project's established patterns and conventions.

  • Creates .github/copilot-instructions.md documenting technology stack, architecture, and coding standards
  • Establishes clear conventions for dependency injection, naming patterns, and Spring Boot usage
  • Provides reference documentation for external integrations and build processes

```

### Access the application:
- Web UI: https://localhost:8080/
Copy link

Copilot AI Dec 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The URL should use "http" instead of "https" for localhost:8080. Standard Spring Boot applications run on HTTP by default unless SSL is explicitly configured.

Suggested change
- Web UI: https://localhost:8080/
- Web UI: http://localhost:8080/

Copilot uses AI. Check for mistakes.
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.

✨ Set up Copilot instructions

3 participants