Repository navigation
docs: rework the roadmap; GeoLibre parity and CONTRIBUTING.md in the repo #747
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 all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
6a186f2
docs: rework the roadmap, move GeoLibre parity into the repo, add CON…
deniial00 b839a06
docs(roadmap): group Next by theme instead of release numbers
Mavrick-F a90849e
docs(roadmap): say what counts as underway; add #745 and #671
Mavrick-F 66e8e86
docs: coordinate first on shared contracts; point agents at the roadmap
Mavrick-F 3058ed1
docs(roadmap): add a goal for staying free and self-contained
Mavrick-F fb8e082
Merge pull request #1 from Mavrick-F/docs/roadmap-themes
deniial00 121239a
docs: address review on the roadmap and parity checklist
deniial00 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
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,49 @@ | ||
| # Contributing to RustGIS | ||
|
|
||
| Contributions are welcome. This page covers what to work on and how to propose it. For build, | ||
| test, docs and release mechanics see [docs/contributing.md](docs/contributing.md); for code | ||
| conventions see [AGENTS.md](AGENTS.md). | ||
|
|
||
| ## Most roadmap items have no issue | ||
|
|
||
| [ROADMAP.md](ROADMAP.md) lists where RustGIS is heading. Only a few of its items link to an | ||
| issue; **most features have no issue yet**. Don't wait for one to appear before starting. If | ||
| something on the roadmap (or not on it) interests you, propose it and open a pull request. | ||
|
|
||
| ## How to contribute a feature | ||
|
|
||
| 1. **Check for an existing issue.** Search the | ||
| [issues](https://github.com/opengeos/RustGIS/issues) and the roadmap. If there is an issue, | ||
| comment on it to say you're taking it. | ||
| 2. **Write a short proposal** if there is no issue. It covers: | ||
| - the problem or workflow it serves; | ||
| - what you plan to build: the commands it adds, where it sits in the ribbon, which formats or | ||
| tools are involved; | ||
| - which crates it touches and whether it adds a dependency; | ||
| - how you will test it. | ||
|
|
||
| Put it in an issue with the | ||
| [feature request](https://github.com/opengeos/RustGIS/issues/new?template=feature_request.yml) | ||
| form, or in the description of a draft pull request. For changes that need coordination (see | ||
| below) use an issue and wait for a maintainer's reply; otherwise either works. | ||
| 3. **Open a pull request.** Draft pull requests are welcome early, to get feedback on the | ||
| approach before the work is finished. Link the issue (`Closes #123`) and fill in the | ||
| [pull request template](.github/pull_request_template.md). Before it is ready for review, it | ||
| must meet the rules and quality gates in [AGENTS.md](AGENTS.md). | ||
|
|
||
| ## Pick freely or coordinate first | ||
|
|
||
| - **Pick freely**: roadmap items marked _(open)_ are self-contained. Open a pull request directly, | ||
| with the proposal in its description; an issue is optional. | ||
| - **Coordinate first**: open a proposal issue and wait for a maintainer's reply before writing much | ||
| code if your change | ||
| - changes the data model (`Feature`, `Coord`, `Renderer`); | ||
| - adds a dependency or a crate; | ||
| - changes the `.rgis` project format, or an existing command's id or parameters (the CLI, | ||
| Python, MCP and saved scripts call commands by id); | ||
| - changes the plugin interface; | ||
| - falls under _Exploratory_ in the roadmap. | ||
|
|
||
| Roadmap themes are not releases or an order; an item moves to Done when it lands. A | ||
| pull request that lands a roadmap item, or an item of [GEOLIBRE_PARITY.md](GEOLIBRE_PARITY.md), | ||
| updates that file in the same change. | ||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.