Add an optional prompt file `CLAUDE.md` by yungyuc · Pull Request #706 · solvcon/modmesh

yungyuc · 2026-03-30T15:01:39Z

The prompt file is added under contrib/prompt/ to help align among contributors who use claude code for coding assist.

CLAUDE.md in the project root is put in .gitignore. It is not checked in version control so everyone can use different contents without conflicting.

To use the prompt file, contributors may create a symbolic link to contrib/prompt/CLAUDE.md, or copy it.

This PR succeeds PR #639.

The prompt file is added under `contrib/prompt/`. `CLAUDE.md` in the project root is put in `.gitignore`. It is not checked in version control so everyone can use different contents without conflicting.

yungyuc · 2026-03-30T15:04:03Z

Took the contents of CLAUDE.md from #639 (comment) (@tigercosmos 's contribution) and revised.

The file is placed under contrib/prompt/.

yungyuc · 2026-03-30T15:05:42Z

@@ -1,9 +1,11 @@
+/CLAUDE.md


Ignore CLAUDE.md in the project root. It is not put in version control and everyone can use their own prompt file.

yungyuc · 2026-03-30T15:06:46Z

 __pycache__/
 build/
 dist/
+profiling/results/


Piggypack a missing ignore entry.

tigercosmos · 2026-04-01T11:16:25Z

I have an opposite opinion. We should put CLAUDE.md at the root. We force everyone follow the same AI instruction to make the output close to the project style and standard.

yungyuc · 2026-04-01T22:50:51Z

I've seen a lot of criss-cross checkins for setting files when they are tracked in version control. A solution is to have a dedicated team to maintain the setting files. But it is not very feasible for an open source project like us.

It's easy for contributors to mix changes to the settings and their work. It will be easy for them to include the setting files in unrelated PRs, and an additional burden to reviewers.

The use of ignoring and separate directory here remove the issue while still keeping the settings under version control.

ThreeMonth03 · 2026-04-02T12:01:19Z

+## Code Style
+
+### C++ Style
+- **Indentation**: 4 spaces (no tabs)
+- **Naming**:
+  - Classes: `CamelCase`
+  - Functions/variables: `snake_case`
+  - Member variables: `m_snake_case` (prefix with `m_`)
+  - Constants: `UPPER_CASE` or `snake_case` (for foreign code interop)
+  - Type aliases: `snake_case_t` or `snake_case_type`
+- **Format**: Use clang-format (`.clang-format` in repo root)
+- **Line length**: No hard limit, prefer < 120 characters
+- **Includes**: Use angle brackets (`#include <...>`), not quotes
+- **Standard**: C++23
+
+### Python Style
+- **Indentation**: 4 spaces (no tabs)
+- **Naming**:
+  - Classes: `CamelCase`
+  - Functions/variables: `snake_case`
+  - Constants: `UPPER_CASE`
+- **Line length**: 79 characters (PEP-8)
+- **Format**: Use flake8
+
+### File Format
+- **Encoding**: UTF-8
+- **Line endings**: Unix (`\n`)
+- **Modelines**: Required at end of files
+
+C++:
+```cpp
+// vim: set ff=unix fenc=utf8 et sw=4 ts=4 sts=4:
+```
+
+Python:
+```python
+# vim: set ff=unix fenc=utf8 et sw=4 ts=4 sts=4 tw=79:
+```


Maybe we could add the description about the existence of STYLE.rst. The explanation of this file is more complete.

Good point. I added in the beginning of this section.

yungyuc

Add a paragraph to point to STYLE.rst. Thank you for the good reminder, @ThreeMonth03 .

yungyuc · 2026-04-02T12:05:53Z

+## Code Style
+
+### C++ Style
+- **Indentation**: 4 spaces (no tabs)
+- **Naming**:
+  - Classes: `CamelCase`
+  - Functions/variables: `snake_case`
+  - Member variables: `m_snake_case` (prefix with `m_`)
+  - Constants: `UPPER_CASE` or `snake_case` (for foreign code interop)
+  - Type aliases: `snake_case_t` or `snake_case_type`
+- **Format**: Use clang-format (`.clang-format` in repo root)
+- **Line length**: No hard limit, prefer < 120 characters
+- **Includes**: Use angle brackets (`#include <...>`), not quotes
+- **Standard**: C++23
+
+### Python Style
+- **Indentation**: 4 spaces (no tabs)
+- **Naming**:
+  - Classes: `CamelCase`
+  - Functions/variables: `snake_case`
+  - Constants: `UPPER_CASE`
+- **Line length**: 79 characters (PEP-8)
+- **Format**: Use flake8
+
+### File Format
+- **Encoding**: UTF-8
+- **Line endings**: Unix (`\n`)
+- **Modelines**: Required at end of files
+
+C++:
+```cpp
+// vim: set ff=unix fenc=utf8 et sw=4 ts=4 sts=4:
+```
+
+Python:
+```python
+# vim: set ff=unix fenc=utf8 et sw=4 ts=4 sts=4 tw=79:
+```


Good point. I added in the beginning of this section.

yungyuc · 2026-04-02T12:06:07Z

+
+## Code Style
+
+For complete description of the code style, use the file `STYLE.rst`.  Important


Mention STYLE.rst here.

No need to take actions. Just want to point out that now we can create a "style check" skill, and make such style intruction inside it.

ThreeMonth03 · 2026-04-02T12:13:15Z

+### Virtual Environments
+
+**IMPORTANT**: Using Python virtual environments (venv, conda) is
+**strongly discouraged** for modmesh development. The project is designed to
+work with system Python. Virtual environment bugs are not actively resolved.


This prompt may be dangerous to newbie, because it implies AI to install the dependency out of virtual enviroment.
We might tell AI to use devenv according to the note, or AI should get the consent from users before it installs dependency packages.

Absolutely.

We might tell AI to use devenv according to the note

I did not include the external hackmd link, in which we can consider to include some contents may be incorporated in the repository, maybe in the form of CI. But it is uncertain and a lot need to be discussed. So maybe it is not the best time to add the link.

yungyuc

Add a passage to ask to use devenv and all installation requires consent.

Thank you, @ThreeMonth03 .

yungyuc · 2026-04-02T12:25:27Z

+### Virtual Environments
+
+**IMPORTANT**: Using Python virtual environments (venv, conda) is
+**strongly discouraged** for modmesh development. The project is designed to
+work with system Python. Virtual environment bugs are not actively resolved.


Absolutely.

yungyuc · 2026-04-02T12:25:46Z

+**strongly discouraged** for modmesh development. The project is designed to
+work with system Python. Virtual environment bugs are not actively resolved.
+
+Use https://github.com/solvcon/devenv to build dependency from source and


Add a passage to ask to use devenv and all installation requires consent.

tigercosmos

LGTM

yungyuc requested review from ExplorerRay and tigercosmos March 30, 2026 15:01

yungyuc self-assigned this Mar 30, 2026

yungyuc added the enhancement New feature or request label Mar 30, 2026

Add AI prompt file CLAUDE.md

cdc86f6

The prompt file is added under `contrib/prompt/`. `CLAUDE.md` in the project root is put in `.gitignore`. It is not checked in version control so everyone can use different contents without conflicting.

yungyuc force-pushed the devtool/claude-prompt branch from f92cbfa to cdc86f6 Compare March 30, 2026 15:05

yungyuc commented Mar 30, 2026

View reviewed changes

yungyuc marked this pull request as ready for review March 30, 2026 15:08

yungyuc added documentation Improvements or additions to documentation and removed enhancement New feature or request labels Mar 30, 2026

ThreeMonth03 reviewed Apr 2, 2026

View reviewed changes

Mention STYLE.rst in CLAUDE.md

4a6cd99

yungyuc commented Apr 2, 2026

View reviewed changes

ThreeMonth03 reviewed Apr 2, 2026

View reviewed changes

Explicitly requires to use devenv to build dependencies

2fc531a

yungyuc commented Apr 2, 2026

View reviewed changes

tigercosmos approved these changes Apr 3, 2026

View reviewed changes

yungyuc merged commit d920511 into solvcon:master Apr 4, 2026
14 checks passed

yungyuc deleted the devtool/claude-prompt branch April 4, 2026 00:38


		## Code Style

		For complete description of the code style, use the file `STYLE.rst`. Important

Conversation

yungyuc commented Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tigercosmos commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yungyuc commented Apr 1, 2026

Uh oh!

ThreeMonth03 Apr 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yungyuc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yungyuc Apr 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yungyuc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tigercosmos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

yungyuc commented Mar 30, 2026 •

edited

Loading

tigercosmos commented Apr 1, 2026 •

edited

Loading

ThreeMonth03 Apr 2, 2026 •

edited

Loading

yungyuc Apr 2, 2026 •

edited

Loading