Skip to content

Conversation

SAKURA-CAT
Copy link
Member

@SAKURA-CAT SAKURA-CAT commented Jun 10, 2025

Description

Initialize swanlab-core project for #1063

CI Workflow Setup

Documentation and Licensing

  • core/README.md: Added a detailed README file explaining the purpose of swanlab-core, IDE setup, linter usage, and development environment configuration.
  • core/LICENSE: Linked the license file to the core directory.

Project Setup

  • core/go.mod: Initialized the Go module for swanlab-core with Go version 1.24.4.

API Scaffolding

  • core/internal/api/api.go: Added an initial API file with metadata comments describing its purpose for handling requests to SwanLab-Server.

@SAKURA-CAT SAKURA-CAT self-assigned this Jun 10, 2025
@SAKURA-CAT SAKURA-CAT added the 💪 enhancement New feature or request label Jun 10, 2025
@SAKURA-CAT SAKURA-CAT marked this pull request as ready for review June 10, 2025 06:23
Copy link

@Copilot 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 initializes the swanlab-core project for issue #1063 by establishing the foundational Go project structure.

  • New Go package for API endpoints is created.
  • Project’s module, README, and LICENSE files have been added.
  • A GitHub workflow for testing the core code is introduced.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
core/internal/api/api.go Adds the API package with documentation metadata comments.
core/go.mod Introduces the module declaration and Go version requirement.
core/README.md Provides project overview and developer setup instructions.
core/LICENSE Adds a LICENSE file referencing a higher-level LICENSE file.
.github/workflows/test-core.yml Implements a GitHub Actions workflow for testing the core code.
Comments suppressed due to low confidence (2)

core/LICENSE:1

  • The LICENSE file contains only a reference to '../LICENSE'. To avoid confusion, consider including the full license text or clarifying its purpose.
../LICENSE

core/README.md:47

  • [nitpick] The 'Env' section is incomplete. Please provide the necessary environment setup information or remove the placeholder if not needed.
TODO

@SAKURA-CAT SAKURA-CAT merged commit f1ae9f0 into feature/core Jun 10, 2025
6 checks passed
@SAKURA-CAT SAKURA-CAT deleted the feat/init-go branch June 10, 2025 07:50
SAKURA-CAT added a commit that referenced this pull request Jun 11, 2025
SAKURA-CAT added a commit that referenced this pull request Jun 11, 2025
* feat: init go project (#1064)

* feat: add proto and grpc

* feat: add proto build script

* fix: golangci lint

* feat: support auto or specify select port

* chore: license

* chore: add .golangci.yml

* fix: use log/slog instead of log

* chore: del core vendor

---------

Co-authored-by: Kang Li <[email protected]>
SAKURA-CAT added a commit that referenced this pull request Jun 15, 2025
* feat: init go project (#1064)

* fix: license use symlink (#1067)

* Feature/protobuf: hello-word (#1074)

* feat: init go project (#1064)

* feat: add proto and grpc

* feat: add proto build script

* fix: golangci lint

* feat: support auto or specify select port

* chore: license

* chore: add .golangci.yml

* fix: use log/slog instead of log

* chore: del core vendor

---------

Co-authored-by: Kang Li <[email protected]>

* feat: impl health checker and init data collector (#1077)

* feat: impl health checker and init data collector

* chore: change module name

---------

Co-authored-by: KAAANG <[email protected]>

* Feat/record proto and column parser (#1091)

Co-authored-by: kaikai <[email protected]>

* fix: import module and typo

---------

Co-authored-by: Kaikai <[email protected]>
Co-authored-by: kaikai <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💪 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants