Skip to content

docs: add CONTRIBUTING.md - #191

Merged
edeso merged 10 commits into
openjump-gis:mainfrom
chrisdebian:docs/contributing-md
Sep 28, 2026
Merged

edeso merged 10 commits into
openjump-gis:mainfrom
chrisdebian:docs/contributing-md

Conversation

@chrisdebian

Copy link
Copy Markdown
Contributor

There's no CONTRIBUTING.md today, so new contributors have no single place pointing them to the wiki setup guide, the actual CI build command, or the fact that issue creation is currently restricted here.

This links the existing wiki page rather than duplicating it, and states mvn -B package -P snapshot since that's what CI already runs.

Docs-only change — no code affected, and mvn -B package -P snapshot succeeds cleanly on current main (147 tests pass).

Links the existing wiki setup guide rather than duplicating it, states
the actual CI build command, and notes that issue creation is
currently restricted so PRs are the way to raise problems.
chrisdebian added a commit to chrisdebian/openjump that referenced this pull request Aug 24, 2026
@edeso

edeso commented Aug 24, 2026

Copy link
Copy Markdown
Member
  1. what do we need roadmap_and_todo_list.md for?

  2. do you by any chance use some Ai to write up these files? did you verify the content by hand?

@chrisdebian

Copy link
Copy Markdown
Contributor Author

Yes, this is written with Claude Code's assistance, and I review and direct each change.

The roadmap_and_todo_list.md file shouldn't have been in this PR at all — it's an internal working-notes file I use to track progress across sessions, not something meant for this repo. It got committed to my fork by mistake and inherited by every branch since. I've removed it from this PR and every other branch it leaked into, and set things up so it can't happen again. Sorry for the noise.

The actual content here (CONTRIBUTING.md) was checked by hand against this repo's current state before submitting — the wiki link, the build command, and the note about issue creation (which I've since corrected on #192, since it turned out to be wrong).

@chrisdebian

Copy link
Copy Markdown
Contributor Author

Hi edeso,

Just checking in on this one and #192. Are they still useful to you, or would you rather I closed them? Either is fine. I'd rather not leave them sitting if they're not wanted.

Comment thread CONTRIBUTING.md Outdated

## Issues

**Issue creation is currently restricted** on this repository — please raise problems or

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we talked about that. what kind of restriction is Claude referring to? i am not aware of any.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, there isn't one — that line was simply wrong, and I'm sorry it survived this long. I corrected the same claim on #192 back in August but missed it here, even though I said then it had been fixed.

The Issues section now just says issues are welcome, with a short note on what to include (version, OS/Java, steps to reproduce). Nothing else in the file has changed. Commit: d6fb93f

@edeso
edeso merged commit bfe9be6 into openjump-gis:main Sep 28, 2026
1 check passed
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.

2 participants