Skip to content

Commit 754c4e1

Browse files
committed
chore: prepare repo for public GitHub publication
- Untrack CLAUDE.md (local AI operating manual, not for public view) - Add CLAUDE.md and .claude/ to .gitignore - Replace USER placeholder with Tools00 in repo URLs (pyproject, CONTRIBUTING, INSTALL, MODEL_CARD, CHANGELOG) - Add short AI-assisted-development disclosure to README
1 parent 9dfa9f0 commit 754c4e1

8 files changed

Lines changed: 24 additions & 141 deletions

File tree

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,7 @@ data/processed/
5050
secrets/
5151
*.pem
5252
*.key
53+
54+
# Local AI operating manual — not for public repo
55+
CLAUDE.md
56+
.claude/

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,5 +92,5 @@ Format: [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) · SemVer.
9292
- Keine Multi-phase Flow
9393
- Nur 1 Validation-Datensatz (analytisch, noch nicht gegen Experiment)
9494

95-
[Unreleased]: https://github.com/USER/pem-ec-designer/compare/v0.1.0...HEAD
96-
[0.1.0]: https://github.com/USER/pem-ec-designer/releases/tag/v0.1.0
95+
[Unreleased]: https://github.com/Tools00/pem-ec-designer/compare/v0.1.0...HEAD
96+
[0.1.0]: https://github.com/Tools00/pem-ec-designer/releases/tag/v0.1.0

CLAUDE.md

Lines changed: 0 additions & 130 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ please read this before opening a PR.
2323
## Dev setup
2424

2525
```bash
26-
git clone https://github.com/USER/pem-ec-designer.git
26+
git clone https://github.com/Tools00/pem-ec-designer.git
2727
cd pem-ec-designer
2828
python -m venv venv
2929
source venv/bin/activate

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,4 +219,13 @@ MIT — see [LICENSE](LICENSE).
219219
## Author
220220

221221
Abed Qadi — Simulation Engineer.
222-
Issues, questions, collaborations → [open an issue on GitHub](https://github.com/).
222+
Issues, questions, collaborations → [open an issue on GitHub](https://github.com/Tools00/pem-ec-designer/issues).
223+
224+
---
225+
226+
## Development note
227+
228+
This project is developed with AI-assisted tooling (Claude Code).
229+
Physics, architecture, and scope decisions are human-reviewed; every
230+
equation carries a literature reference, and all results are validated
231+
against analytical checks and published data (see [MODEL_CARD.md](docs/MODEL_CARD.md)).

docs/INSTALL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Detailed setup instructions for development and local use.
1919

2020
```bash
2121
# Clone
22-
git clone https://github.com/USER/pem-ec-designer.git
22+
git clone https://github.com/Tools00/pem-ec-designer.git
2323
cd pem-ec-designer
2424

2525
# Virtual environment
@@ -46,7 +46,7 @@ pytest tests/ -v
4646
curl -LsSf https://astral.sh/uv/install.sh | sh
4747

4848
# Clone
49-
git clone https://github.com/USER/pem-ec-designer.git
49+
git clone https://github.com/Tools00/pem-ec-designer.git
5050
cd pem-ec-designer
5151

5252
# Create env and install from pyproject.toml

docs/MODEL_CARD.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ byte-identical outputs.
167167
title = {{PEM-EC Designer: Physics-Based Simulation of PEM Water Electrolysis}},
168168
version = {0.2.0},
169169
year = {2026},
170-
url = {https://github.com/USER/pem-ec-designer}
170+
url = {https://github.com/Tools00/pem-ec-designer}
171171
}
172172
```
173173

pyproject.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@ dev = [
4545
]
4646

4747
[project.urls]
48-
Homepage = "https://github.com/USER/pem-ec-designer"
49-
Repository = "https://github.com/USER/pem-ec-designer"
50-
Issues = "https://github.com/USER/pem-ec-designer/issues"
51-
Changelog = "https://github.com/USER/pem-ec-designer/blob/main/CHANGELOG.md"
48+
Homepage = "https://github.com/Tools00/pem-ec-designer"
49+
Repository = "https://github.com/Tools00/pem-ec-designer"
50+
Issues = "https://github.com/Tools00/pem-ec-designer/issues"
51+
Changelog = "https://github.com/Tools00/pem-ec-designer/blob/main/CHANGELOG.md"
5252

5353
[tool.setuptools.packages.find]
5454
where = ["."]

0 commit comments

Comments
 (0)