Repository navigation
docs: add CONTRIBUTING.md #191
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
15d7d22
docs: add fact-checked onboarding roadmap
chrisdebian 4eb7a02
docs: #145 triaged - r5312 SRID-exclusion fix confirmed present in so…
chrisdebian 43e4065
docs: #43 triaged - modified flag reset confirmed missing in source
chrisdebian f447897
docs: #41 triaged - root cause confirmed (raw URI in DataSource param…
chrisdebian da38028
docs: record Maven install and build-confirmation follow-ups on #41/#…
chrisdebian 3b9a1cf
docs: add CONTRIBUTING.md
chrisdebian 92a58d9
chore: remove internal tracking doc, shouldn't have been pushed here
chrisdebian d6fb93f
docs: correct the Issues section, issues are open to everyone
chrisdebian 9d19e3e
add links, minor spelling change, rephrasing
edeso 9c089c0
Merge branch 'main' into docs/contributing-md
edeso File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Contributing to OpenJUMP | ||
|
|
||
| Thanks for your interest in contributing! OpenJUMP is maintained by a small team of volunteers, | ||
| so clear, focused contributions are the most useful kind. | ||
|
|
||
| ## Setting up a development environment | ||
|
|
||
| OJ uses Maven and works with Eclipse, IntelliJ IDEA, or any Maven-aware Java IDE. For a full | ||
| walkthrough of setting up **OJ Core** or the **HelloWorld Extension**, see the wiki: | ||
|
|
||
| https://ojwiki.soldin.de/index.php?title=Eclipse:_Set_up_project_and_example_extension_from_git_sources | ||
|
|
||
| To build from the command line: | ||
|
|
||
| ``` | ||
| mvn -B package -P snapshot | ||
| ``` | ||
|
|
||
| This is also what CI runs on every push, so it's the quickest way to confirm your change builds | ||
| cleanly before opening a PR. | ||
|
|
||
| ## Before opening a pull request | ||
|
|
||
| - **Build and run your change locally first.** A PR without at least a local `mvn -B package -P | ||
| snapshot` pass (and, for anything touching the UI, an actual run of the built application) | ||
| isn't ready for review yet. | ||
| - **Keep it scoped.** One logical change per PR — please don't bundle an unrelated fix, refactor, | ||
| or formatting pass in with the change you're actually proposing. Smaller PRs are easier to | ||
| review and easier to revert if something goes wrong. | ||
| - **Reference the issue it addresses**, where one exists, in the PR description. | ||
| - If you're fixing a bug reported a while ago, it's worth confirming it still reproduces against | ||
| current `main` first — some issues predate later refactors and may already be partially or | ||
| fully resolved. | ||
|
|
||
| ## Issues | ||
|
|
||
| **Issue creation is currently restricted** on this repository — please raise problems or | ||
| proposals as a pull request instead, even a small or partial one, rather than opening a new | ||
| issue. If you've found and fixed something, that's the most useful way to bring it to the | ||
| maintainers' attention. | ||
|
|
||
| ## Licence | ||
|
|
||
| OpenJUMP is licensed under the GNU General Public License v2 (GPLv2). By submitting a | ||
| contribution, you agree it will be distributed under the same licence. | ||
|
|
||
| ## Extensions | ||
|
|
||
| If your contribution is really a standalone plugin rather than a change to OJ Core, consider | ||
| whether it belongs in its own extension repository instead — see the README's Extensions section | ||
| for the naming convention (`xxx-extension`, `xxx-driver`) and the | ||
| [HelloWorldExtension](https://github.com/openjump-gis/helloworld-extension) example. | ||
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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