Skip to content

docs(contributing): add detailed contributing guidelines#383

Merged
flc1125 merged 2 commits into3.xfrom
contributing
Mar 9, 2026
Merged

docs(contributing): add detailed contributing guidelines#383
flc1125 merged 2 commits into3.xfrom
contributing

Conversation

@flc1125
Copy link
Copy Markdown
Owner

@flc1125 flc1125 commented Mar 9, 2026

No description provided.

…pport

- Provide steps for confirming upstream parsing support before changes
- Describe how to add listener interfaces in listeners.go
- Explain dispatcher registration and event routing in dispatcher.go
- Outline testing requirements with examples for dispatcher_test.go
- Include naming conventions and reference implementations
- Emphasize scope and focus for typical event support pull requests
Copilot AI review requested due to automatic review settings March 9, 2026 04:04
@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Mar 9, 2026
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a CONTRIBUTING.md file to establish clear and detailed guidelines for project contributions. The document outlines essential development practices, such as linting and testing, and provides a step-by-step guide for integrating support for new GitLab webhook events, aiming to streamline the contribution process and maintain consistency across the project.

Highlights

  • Contributing Guidelines: A new CONTRIBUTING.md file has been added to the repository, providing comprehensive instructions for developers on how to contribute to the project. It covers general development practices and detailed steps for adding support for new GitLab webhook events.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • CONTRIBUTING.md
    • Added a new file outlining detailed contributing guidelines for the project.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 9, 2026

Warning

Rate limit exceeded

@flc1125 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 10 minutes and 22 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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9be99941-35d9-4335-928d-09416772de05

📥 Commits

Reviewing files that changed from the base of the PR and between 5e1db4e and 1a826bf.

📒 Files selected for processing (1)
  • CONTRIBUTING.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch contributing

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a CONTRIBUTING.md file, which provides excellent and detailed guidelines for developers looking to add support for new GitLab webhook events. The document is well-structured and clear. I have one suggestion to improve the long-term maintainability of a URL within the documentation.

Note: Security Review has been skipped due to the limited scope of the PR.

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.55%. Comparing base (5e1db4e) to head (1a826bf).
⚠️ Report is 1 commits behind head on 3.x.

Additional details and impacted files
@@           Coverage Diff           @@
##              3.x     #383   +/-   ##
=======================================
  Coverage   92.55%   92.55%           
=======================================
  Files           1        1           
  Lines         215      215           
=======================================
  Hits          199      199           
  Misses         11       11           
  Partials        5        5           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dosubot dosubot bot added the documentation Improvements or additions to documentation label Mar 9, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a new CONTRIBUTING.md to document how to contribute, with a focus on the repository’s established workflow for adding support for additional GitLab webhook event types.

Changes:

  • Adds basic development steps (make lint, make test) to run before submitting changes.
  • Documents a step-by-step process for adding support for new webhook events (verify upstream parsing, add listener, wire dispatcher, add tests/fixtures).
  • Provides naming conventions and examples aligned with the existing dispatcher/listener design.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@flc1125 flc1125 merged commit 82748aa into 3.x Mar 9, 2026
12 checks passed
@flc1125 flc1125 deleted the contributing branch March 9, 2026 04:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants