Repository navigation
chore: portfolio-ready repository - #1
Merged
Merged
Conversation
Rewrite the README in English as a portfolio page: what the project does, how to build and run it with commands checked locally, its structure, what it demonstrates and its school context, so that a visitor understands it in a minute.
Give the repository the standard files of a public project: a license so that reuse is allowed (MIT, unless one already existed), a changelog that records 1.0.0 as the version delivered for the assignment, short contributing and security guides, and the Contributor Covenant.
Keep build output, IDE settings and OS files out of the repository, and share basic editor settings without touching the existing sources.
Structure incoming issues and pull requests, assign a default reviewer and keep the workflow actions up to date.
Check on every pull request that the project still builds, with the real build command, and that no secret is committed; publish a GitHub Release from the CHANGELOG when a vX.Y.Z tag is pushed.
Present the project with several real states (rendered from actual runs) in a Screenshots gallery with captions, instead of a single image.
LaCobble
added a commit
that referenced
this pull request
Oct 22, 2026
## Context Old public school project, tidied up as a portfolio piece: clear README, license, versioning and standard GitHub tooling. No change to the source code. ## Changes - **README** rewritten in English as a portfolio page (what it does, build and run, structure, what it demonstrates, school context, license). - **LICENSE (MIT, LaCobble)**, **CHANGELOG.md** (Keep a Changelog, `1.0.0` = version delivered for the assignment), **CONTRIBUTING.md**, **SECURITY.md** (private reporting to contact@lacobble.dev), **CODE_OF_CONDUCT.md** (Contributor Covenant 2.1). - **.gitignore** and **.editorconfig**. - **.github/**: issue templates (bug, feature), PR template, CODEOWNERS, Dependabot (GitHub Actions). - **CI** (`ci.yml`, Linux): required files, compilation with `javac` (JDK 17), secret scan with gitleaks. **Release** (`release.yml`): GitHub Release from the CHANGELOG on each `vX.Y.Z` tag. - **Screenshots gallery**: start, game in progress and win, rendered from the real Swing window during a run (clicks sent to the grid by a small local test driver). ## Tests - `javac -encoding UTF-8 -d out src/*.java` with JDK 17: OK (deprecation notes only, `java.util.Observable`). - Game launched from `src/`: the window opens; the screenshot in the README is rendered from the real Swing content pane. - CI: green (build + gitleaks). ## Risks / points of attention - Documentation and tooling only; the sources are untouched (they keep their CRLF line endings, which `.editorconfig` leaves alone). - The README now says the UI is a Swing GUI (the old README wrongly said console-based).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
Old public school project, tidied up as a portfolio piece: clear README, license, versioning and standard GitHub tooling. No change to the source code.
Changes
1.0.0= version delivered for the assignment), CONTRIBUTING.md, SECURITY.md (private reporting to contact@lacobble.dev), CODE_OF_CONDUCT.md (Contributor Covenant 2.1).ci.yml, Linux): required files, compilation withjavac(JDK 17), secret scan with gitleaks. Release (release.yml): GitHub Release from the CHANGELOG on eachvX.Y.Ztag.Tests
javac -encoding UTF-8 -d out src/*.javawith JDK 17: OK (deprecation notes only,java.util.Observable).src/: the window opens; the screenshot in the README is rendered from the real Swing content pane.Risks / points of attention
.editorconfigleaves alone).