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(readme): Add link to Getting Started on devland + yarn infra step #14361

Merged
merged 4 commits into from
Apr 4, 2024

Conversation

juni-haukur
Copy link
Member

@juni-haukur juni-haukur commented Apr 4, 2024

...

Attach a link to issue if relevant

What

Specify what you're trying to achieve

Why

Specify why you need to achieve this

Screenshots / Gifs

Attach Screenshots / Gifs to help reviewers understand the scope of the pull request

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • Documentation
    • Added a section for new developers in the README with a guide link.
    • Updated setup instructions to include running yarn infra.

@juni-haukur juni-haukur requested a review from a team as a code owner April 4, 2024 11:18
Copy link
Contributor

coderabbitai bot commented Apr 4, 2024

Walkthrough

This update enhances the README.md by adding a new section tailored for new developers, featuring a guide link to facilitate onboarding. Moreover, the setup instructions now incorporate a critical step, yarn infra, to ensure the proper establishment of the project infrastructure from the outset.

Changes

File Change Summary
README.md Added a section for new developers with a guide link; Included a step for running yarn infra in setup instructions.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@juni-haukur juni-haukur changed the title Add link to getting started on devland + yarn infra step fix(readme): Add link to Getting Started on devland + yarn infra step Apr 4, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Review Status

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 5354131 and 189bd08.
Files selected for processing (1)
  • README.md (2 hunks)

README.md Outdated Show resolved Hide resolved
busla
busla previously requested changes Apr 4, 2024
README.md Outdated Show resolved Hide resolved
Co-authored-by: Jón Levy <[email protected]>
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

Review Status

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 189bd08 and 91357e6.
Files selected for processing (1)
  • README.md (2 hunks)

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@datadog-island-is
Copy link

Datadog Report

Branch report: fix/update-root-readme
Commit report: 1a6fb87
Test service: web

✅ 0 Failed, 84 Passed, 0 Skipped, 3.38s Wall Time

Copy link

codecov bot commented Apr 4, 2024

Codecov Report

Merging #14361 (91357e6) into main (e2f7f52) will decrease coverage by 0.26%.
The diff coverage is n/a.

❗ Current head 91357e6 differs from pull request most recent head ff82c36. Consider uploading reports for the commit ff82c36 to get more accurate results

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #14361      +/-   ##
==========================================
- Coverage   37.20%   36.94%   -0.26%     
==========================================
  Files        6142     6133       -9     
  Lines      123852   123736     -116     
  Branches    35337    35312      -25     
==========================================
- Hits        46075    45714     -361     
- Misses      77777    78022     +245     
Flag Coverage Δ
web 1.98% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 42 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e2f7f52...ff82c36. Read the comment docs.

@juni-haukur juni-haukur requested a review from busla April 4, 2024 13:13
README.md Show resolved Hide resolved
@busla busla added the automerge Merge this PR as soon as all checks pass label Apr 4, 2024
@saevarma saevarma dismissed busla’s stale review April 4, 2024 22:46

Already addressed.

@kodiakhq kodiakhq bot merged commit f128a0e into main Apr 4, 2024
23 checks passed
@kodiakhq kodiakhq bot deleted the fix/update-root-readme branch April 4, 2024 22:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants