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

Remove dev env from contributing nexus #17014

Merged
merged 1 commit into from
Aug 16, 2024
Merged

Remove dev env from contributing nexus #17014

merged 1 commit into from
Aug 16, 2024

Conversation

seanbudd
Copy link
Member

@seanbudd seanbudd commented Aug 16, 2024

Summary of the issue:

The contributing page is a list of central pages for different ways to contribute.
Setting up a dev environment doesn't quite come under "a way to contribute" and is part of the above guide.

Description of user facing changes

Description of development approach

Remove this, alternatively it could be listed as a sub-point

Testing strategy:

Known issues with pull request:

Code Review Checklist:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

Summary by CodeRabbit

  • Documentation
    • Updated the contributing guidelines by removing a reference to the "Setting up a development environment" section, streamlining the information for new contributors.

Copy link
Contributor

coderabbitai bot commented Aug 16, 2024

Walkthrough

The recent changes primarily involve the removal of a line in the .github/CONTRIBUTING.md file that directed contributors to the "Setting up a development environment" section. This adjustment streamlines the contribution guidelines by removing specific setup instructions while retaining information on testing, translating, and code contributions, which may affect how new contributors engage with the project.

Changes

Files Change Summary
.github/CONTRIBUTING.md Removed reference to "Setting up a development environment" section, streamlining contribution guidelines.

Sequence Diagram(s)

sequenceDiagram
    participant Contributor
    participant Project
    Contributor->>Project: Submits Contribution
    Project->>Contributor: Reviews Contribution
    Contributor->>Project: Provides Feedback (if necessary)
    Project->>Contributor: Accepts Contribution
Loading

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 83b2e0a and 5bf8051.

Files selected for processing (1)
  • .github/CONTRIBUTING.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • .github/CONTRIBUTING.md

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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

CodeRabbit Configuration 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/schema.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.

@SaschaCowley SaschaCowley merged commit 38e2f73 into master Aug 16, 2024
4 checks passed
@SaschaCowley SaschaCowley deleted the removeDevEnv branch August 16, 2024 04:39
@github-actions github-actions bot added this to the 2024.4 milestone Aug 16, 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.

2 participants