Skip to content

docs: add contributing guide and CLAUDE.md#32

Merged
VdustR merged 3 commits intomainfrom
docs/contributing
Feb 4, 2026
Merged

docs: add contributing guide and CLAUDE.md#32
VdustR merged 3 commits intomainfrom
docs/contributing

Conversation

@VdustR
Copy link
Collaborator

@VdustR VdustR commented Feb 4, 2026

Summary

  • Add CLAUDE.md with architecture overview and common patterns
  • Update README.md with contributing section
  • Document the TS2742 issue and fix for dynamic imports

🤖 Generated with Claude Code

@gemini-code-assist
Copy link

Summary of Changes

Hello @VdustR, 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 significantly improves the project's developer experience by introducing detailed documentation for contributing to the ESLint configuration. It provides an architectural overview, explains critical development patterns, and offers troubleshooting for common issues, thereby lowering the barrier to entry for new contributors and standardizing development practices.

Highlights

  • New CLAUDE.md Documentation: A comprehensive guide for ESLint config development has been added, detailing architecture, key patterns, commands, release process, and common issues.
  • Enhanced README.md Contributing Guide: The README.md now includes a dedicated "Contributing" section with development setup, release procedures, and specific guidance for implementing dynamic import wrappers.
  • TS2742 Issue Resolution: The documentation explicitly addresses and provides solutions for the TS2742 TypeScript error encountered with dynamic imports, ensuring smoother development.

🧠 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
  • CLAUDE.md
    • New file added, providing an ESLint Config Development Guide.
    • Details project architecture, dynamic import patterns, extendsConfig usage, and config structure.
    • Includes commands for building, testing, type checking, and linting.
    • Explains the release process via changesets.
    • Documents common issues, specifically the TS2742 TypeScript error and its fix.
  • README.md
    • The "Release" section was replaced and expanded into a new "Contributing" section.
    • Added development setup instructions, including pnpm install, build, test, checkTypes, and lint commands.
    • Updated release instructions to use pnpm changeset.
    • Introduced a new subsection "Adding Dynamic Import Wrappers" with a code example.
    • Added a reference to the newly created CLAUDE.md for more detailed information.
Activity
  • VdustR authored this pull request.
  • The changes involve adding new documentation and updating existing README content.
  • The PR description indicates that the content was generated with "Claude Code".
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.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@VdustR VdustR force-pushed the docs/contributing branch from 19b0374 to aced20e Compare February 4, 2026 05:02
Copy link

@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 excellent documentation with a new CLAUDE.md development guide and an updated README.md with a contributing section. The changes are clear and provide valuable information for contributors. I've added a couple of minor suggestions to improve the clarity of the development commands in both files.

VdustR and others added 2 commits February 4, 2026 13:03
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@VdustR VdustR merged commit 71e42b2 into main Feb 4, 2026
4 checks passed
@VdustR VdustR deleted the docs/contributing branch February 4, 2026 05:05
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.

1 participant