Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update shardeum package name and add linear linking instructions #63

Merged
merged 1 commit into from
Mar 17, 2025

Conversation

shanejonas
Copy link
Collaborator

@shanejonas shanejonas commented Mar 17, 2025

PR Type

enhancement, documentation


Description

  • Update package name from @shardeum to @shardeum-foundation.

  • Add instructions for Linear issue linking in PRs.

  • Ensure PRs are linked to Linear issues via description, title, branch, or commit.

  • Provide guidelines for unit testing with mocked external dependencies.


Changes walkthrough 📝

Relevant files
Enhancement
reusable-node-ci.yml
Update package name and add Linear linking instructions   

.github/workflows/reusable-node-ci.yml

  • Updated package name from @shardeum to @shardeum-foundation.
  • Added instructions for linking PRs to Linear issues.
  • Included guidelines for unit testing practices.
  • +8/-1     

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • @shanejonas shanejonas requested a review from a team as a code owner March 17, 2025 18:46
    Copy link

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

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

    Documentation Clarity

    Ensure that the instructions for linking PRs to Linear issues are clear and unambiguous, as this is a new addition to the workflow guidelines.

    ### Linear Integration
    We should make sure that each PR is linked to a Linear issue.
    - One of the following must be true:
      - The PR description includes the Linear issue key (e.g. `SHARD-123`)
      - The PR title includes the Linear issue key (e.g. `P1-123`)
      - The PR branch name includes the Linear issue key (e.g. `P1-123`)
      - The commit messages include the Linear issue key (e.g. `P1-123`)

    Copy link

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @shanejonas shanejonas merged commit 1abf7b1 into main Mar 17, 2025
    5 checks passed
    @shanejonas shanejonas deleted the fix/more-instructions branch March 17, 2025 18:54
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants