Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ign-argentina/argenmap/llms.txt

Use this file to discover all available pages before exploring further.

Argenmap is an open-source map viewer developed by Argentina’s Instituto Geográfico Nacional (IGN) and published under the GPL-3.0 license. Contributions of all kinds are welcome — from bug fixes and performance improvements to documentation updates — and are submitted through pull requests on GitHub. Before opening your first PR, read these guidelines carefully so your contribution has the best chance of being reviewed and merged quickly. The development team can also be contacted through the IGN website.

General Philosophy

Argenmap is committed to keeping its codebase simple, lightweight, and fast. Features that add unnecessary bulk — even well-intentioned ones — are harder to justify merging into the core project. As a rule of thumb, the contributions most likely to be accepted quickly are:
  • Bug fixes that correct clear, reproducible defects
  • Performance improvements that reduce load time or memory usage
  • Small, focused additions that solve a concrete problem without bloating the codebase
If your idea is large or highly specialized, consider whether it would work better as a separate plugin in its own repository rather than as a change to the Argenmap core.

Before Opening a Pull Request

Taking a few minutes before you start coding can save everyone significant review time. Ask yourself:
  1. Is this feature important enough for the core? Could it live as a plugin in a separate repository and still serve users well?
  2. Is the implementation concise? Does it add a minimal amount of code while solving the problem clearly?
  3. Does a similar PR or issue already exist? Check the issues list before duplicating work.
Search existing issues and open pull requests before starting new work. Someone may already be solving the same problem, or a maintainer may have already ruled out the approach. Browse the tracker at github.com/ign-argentina/argenmap/issues.

PR Guidelines

Each pull request you submit should follow these rules. They exist to keep the review process fast and to protect the stability of the project.
1

One change per PR

Each pull request must address a single issue or add a single feature. Bundling multiple unrelated changes into one PR makes reviewing difficult and slows down integration. If you have two improvements, open two PRs.
2

Include test cases

Provide test cases that demonstrate either that a bug is fixed or that a new feature works as intended. Reviewers should be able to run your tests and verify the change without guesswork.
3

Use feature branches — never commit to master

Always create a dedicated topic branch for your changes. Committing directly to the master branch of your fork means unrelated changes may leak into the same pull request. Keep branches focused and well-named.
4

Separate formatting from functional changes

Do not mix code formatting or whitespace cleanup with bug fixes or new functionality. Formatting changes, even when harmless on their own, make patches much harder to review. If you need to reformat code, do it in a separate commit.
5

Update documentation after a merge

If your feature or improvement is merged into the main branch, follow up with a second pull request that updates the relevant documentation. Keeping docs in sync with code is treated as part of the contribution.

Review Process

Once your pull request is open, the IGN development team will review it as soon as possible.
1

Initial review

A maintainer will read through your changes and may ask clarifying questions or request adjustments to align with project conventions.
2

Requested changes

If changes are requested, update your branch and push again — the PR will update automatically. Respond to comments to keep the conversation moving.
3

Merge

Once the changes are approved, your contribution will be merged into the appropriate branch. Thank you for your patience during the review process.

Non-Code Contributions

You don’t need to write code to make a meaningful contribution to Argenmap. There are several other valuable ways to help:

Test the Beta

Visit the beta deployment and put it through its paces. Report any problems or suggestions you find as GitHub issues.

Improve Documentation

Found something confusing or missing in the docs? Open an issue or submit a PR with clarifications and improvements.

Help Other Users

Browse open issues and answer questions from other users. Helping someone debug their configuration saves maintainer time.

Share the Project

Share Argenmap with colleagues, in forums, and on social media. The more people who know about it, the better the project becomes.
The beta at mapa.ign.gob.ar/beta is the best place to test unreleased features before they land in the stable release. If you discover a bug there, open an issue — early bug reports from beta testers are especially valuable.

Build docs developers (and LLMs) love