Skip to content

Conversation

piste2750
Copy link
Member

@piste2750 piste2750 commented Aug 17, 2025

Summary of changes

  • Add CLAUDE.md for working with the claude code
    • This file indform the Claude Code what is this project and how to develop codes
  • Modify code convention for give more strict order to the claude code
    • This file educates the Claude Code what is out coding style correctly

Description

Claude code is a powerful tool to accelerate software development. We need to prepare the way to inform our project to AI correctly before developer start using AI.

Type of change

  • New feature (non-breaking change which adds functionality)

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have confirmed my fix is effective or that my feature works

To give more strict order to the clause code, coding convention is modified also.
@vandelvan
Copy link
Member

Hi! Could you please enhance the description of this pull request? A lot of developers (myself included) are somewhat skeptical about "vibe-coding" practices since they can often introduce more technical debt or produce wrong results that take longer to correct than to make the functions from scratch (even with "well-made prompts"), besides the privacy concerns associated with all forms of Gen-AI. How do you plan to use it?

@piste-jp
Copy link
Member

CLAUDE.md is used only when Claude Code is launched. So developers who don't use Claude Code never make any effect. I don't think more explanation is needed.

A lot of developers (myself included) are somewhat skeptical about "vibe-coding" practices since they can often introduce more technical debt or produce wrong results that take longer to correct than to make the functions from scratch (even with "well-made prompts"), besides the privacy concerns associated with all forms of Gen-AI. How do you plan to use it?

A lot of developers already use AI for SW development. And it is your choice using AI or not.

I never enforce to use AI. But using Clause Code without CALUDE.md might cause serial problem. And all developers creates their own CLAUDE.md is just a wast of time.

Can you detect the code that is generated by AI, written by human or mixture of both? I believe only we can do is review codes in PR by quality. Who wrote it is not an important issue.

@vandelvan
Copy link
Member

I believe only we can do is review codes in PR by quality.

You are correct, the PR is what matters ultimately, and we can see the quality of the code there, thanks!

I still have a couple of questions more.

Don't you think it would be better to keep the current code convention as it is, perhaps enhance it but not making it specifically for AIs, so human contributors can follow the guidelines? Instead, create a separate code convention file specific for AIs.

Also, making it all specifically for Claude code perhaps is not the correct approach since:

  1. It is not free ($17-100+ USD monthly)
  2. Not everyone uses Claude code.

I agree that the users that use Claude code might need the Claude.md file, but it is not an accessible tool, so not everyone is going to use it. If we add a claude.md, we should also add whatever other files the other available coding AI tools require (Copilot, ChatGPT, WatsonX code assistant, Replit, etc.). So It would be better to implement a code convention file for any Gen-AI assisted coding tool to use, and not limit the users to a specific and costly tool.

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.

3 participants