Skip to content

1050 update readme to include common error build step for semosssdk#1051

Merged
kzsb03 merged 5 commits intodevfrom
1050-update-readme-to-include-build-steps-for-semosssdk
May 8, 2025
Merged

1050 update readme to include common error build step for semosssdk#1051
kzsb03 merged 5 commits intodevfrom
1050-update-readme-to-include-build-steps-for-semosssdk

Conversation

@tzylks
Copy link
Copy Markdown
Contributor

@tzylks tzylks commented May 6, 2025

Description

Update README to include additional build step

Changes Made

Included additional build step in README.md

tzylks added 2 commits May 6, 2025 11:42
Include additional step for building SDK
Update markup
@tzylks tzylks requested a review from a team as a code owner May 6, 2025 18:44
@tzylks tzylks linked an issue May 6, 2025 that may be closed by this pull request
@github-actions
Copy link
Copy Markdown

github-actions bot commented May 6, 2025

@CodiumAI-Agent /describe

@QodoAI-Agent
Copy link
Copy Markdown

Title

1050 update readme to include build steps for semosssdk


User description

Description

Update README to include additional build step

Changes Made

Included additional build step in README.md


PR Type

Documentation


Description

Add SDK build step
Renumber subsequent steps


Changes walkthrough 📝

Relevant files
Documentation
README.md
Update README with SDK build instructions                               

README.md

  • Added step for SDK build
  • Renumbered development and storybook steps
  • +5/-3     

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • @github-actions
    Copy link
    Copy Markdown

    github-actions bot commented May 6, 2025

    @CodiumAI-Agent /review

    @QodoAI-Agent
    Copy link
    Copy Markdown

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Path Separator Consistency

    The build instructions use a Windows-style path (.\libs\) which is inconsistent with other Unix-style paths (./lib/sdk). Consider standardizing on one format for clarity and cross-platform compatibility.

    5. Component library development through storybook. Change directories into libs `cd .\libs\` and run `pnpm run storybook`
    Formatting Consistency

    There's an extra space before run in the dev:client instruction. Consistent spacing improves readability.

    4. For local development on our new ui (./packages/client) and the component library (./libs)  run `pnpm run dev:client`

    @github-actions
    Copy link
    Copy Markdown

    github-actions bot commented May 6, 2025

    @CodiumAI-Agent /improve

    @QodoAI-Agent
    Copy link
    Copy Markdown

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @tzylks tzylks changed the title 1050 update readme to include build steps for semosssdk 1050 update readme to include common error build step for semosssdk May 6, 2025
    tzylks added 2 commits May 6, 2025 12:02
    Include in the common errors section, and remove from build steps
    @kzsb03 kzsb03 merged commit f393fd4 into dev May 8, 2025
    3 checks passed
    @kzsb03 kzsb03 deleted the 1050-update-readme-to-include-build-steps-for-semosssdk branch May 8, 2025 10:58
    @github-actions
    Copy link
    Copy Markdown

    github-actions bot commented May 8, 2025

    @CodiumAI-Agent /update_changelog

    @QodoAI-Agent
    Copy link
    Copy Markdown

    Changelog updates: 🔄

    2025-05-08 #1051

    Changed

    • Updated README to include common SDK build step for semosssdk.

    to commit the new content to the CHANGELOG.md file, please type:
    '/update_changelog --pr_update_changelog.push_changelog_changes=true'

    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.

    Update README to include build steps for semoss/sdk

    3 participants