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

specs: Move to dedicated repo #9121

Merged
merged 1 commit into from
Jan 22, 2024
Merged

specs: Move to dedicated repo #9121

merged 1 commit into from
Jan 22, 2024

Conversation

mslipper
Copy link
Collaborator

No description provided.

@mslipper mslipper requested review from a team as code owners January 20, 2024 19:05
@mslipper mslipper requested review from clabby and Inphi January 20, 2024 19:05
Copy link
Contributor

coderabbitai bot commented Jan 20, 2024

Warning

Rate Limit Exceeded

@mslipper has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 28 minutes and 41 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 8fc0fcb and 6c2525e.

Walkthrough

The recent update involves streamlining the CI/CD pipeline by removing jobs related to bedrock-markdown processing. These changes suggest a possible deprecation or migration of markdown-related processes. Additionally, the specifications documentation has been relocated, and the main reference in the README is now pointing to this new location.

Changes

File Path Change Summary
.circleci/config.yml Removed jobs bedrock-markdown and bedrock-markdown-links, and their associated steps. Removed bedrock-markdown job from workflows.
README.md Updated link for contributing to the OP Stack from a local path to a GitHub URL. Removed the "specs" directory from the list of components.
specs/README.md Content removed and replaced with a link to the specifications' new location.

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@protolambda protolambda left a comment

Choose a reason for hiding this comment

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

specs/meta/devnet.md, specs/meta/linting.md, specs/meta/versioning.md may find a better new home in the docs dir. I'm fine with removing these though, as the CONTRIBUTING.md already covers these topics, and automation is better than the manual commands in these old meta docs.

Also, maybe we can remove the specs link from the README dir tree-view, and add a new separate section that links to the specs repository?

@mslipper mslipper force-pushed the feat/move-out-specs branch from 3bd02fb to 6c2525e Compare January 21, 2024 01:09
@refcell refcell mentioned this pull request Jan 22, 2024
Copy link
Contributor

@axelKingsley axelKingsley left a comment

Choose a reason for hiding this comment

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

Looks clean!

Lines which are "added" are modifications to disconnect linting or otherwise point at the new location.

Copy link
Contributor

@refcell refcell left a comment

Choose a reason for hiding this comment

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

LGTM

@mslipper mslipper added this pull request to the merge queue Jan 22, 2024
Merged via the queue into develop with commit 84801c9 Jan 22, 2024
8 checks passed
@mslipper mslipper deleted the feat/move-out-specs branch January 22, 2024 20:52
dshiell pushed a commit to polymerdao/optimism-dev that referenced this pull request Jan 22, 2024
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.

5 participants