argx is developed and maintained by Selemis B.V.
Contributions from the community are welcome.
For bug fixes, documentation improvements, tests, and other small, well-scoped changes, feel free to open a pull request directly.
For larger changes, new features or public API changes, please open an issue first so the design can be discussed before substantial implementation work begins.
If you encounter a bug, please check whether an existing issue already covers it before opening a new one.
Good bug reports include:
- a minimal reproduction where practical;
- the
argxand Rust versions involved; - the expected and observed behavior;
- relevant logs or error messages;
- any investigation or root-cause analysis you have already done.
Feature proposals should explain the problem being solved, the intended behavior, and why it belongs in argx rather than in application code or a separate integration.
Run the test suite with:
make testRun linting and formatting checks with:
make lintBuild the documentation locally with:
make docThe documentation build uses nightly rustdoc with all features enabled, the docsrs configuration, private items included, and warnings denied. It is intentionally stricter than the public documentation build on docs.rs.
Before submitting a pull request, run the complete repository verification:
make prThis runs the repository's formatting, linting, tests, examples, doctests, documentation checks, and other verification steps.
Documentation is part of the public contract. When behavior or APIs change, update the crate-level documentation, API documentation, README, or examples wherever that change is visible to users.
Prefer comments that explain invariants, ordering requirements, generated-code boundaries, or why an implementation is structured a particular way. Avoid comments that merely restate straightforward Rust.
Public APIs should include doctests when a small, deterministic example can exercise the stable behavior directly. Runnable examples should begin with module-level documentation that explains what the example demonstrates, how to invoke it, and any semantics that are not obvious from the code alone.
Keep pull requests focused on a single logical change.
Please include tests for behavioral changes and update documentation when public behavior or APIs change. New functionality should use argx's existing abstractions where possible rather than introducing parallel implementations.
Before submitting a pull request, run make pr. See Development for the local development and verification workflow.
Pull requests may be asked to change substantially or be declined if the proposed design does not fit argx's scope, even when the implementation itself is correct.
argx supports Linux and macOS natively. Windows development and execution are
supported through the Windows Subsystem for Linux (WSL); native Windows targets
are not supported. Changes should remain portable across the supported Unix
platforms and avoid Linux-specific assumptions unless they are explicitly
required and guarded.
argx is currently pre-1.0. Breaking changes may still be made when they materially improve the API.
If you believe you have found a security vulnerability, please do not report it through GitHub Issues or a public pull request.
See our Security Policy for reporting instructions.
argx is dual licensed under the Apache License, Version 2.0 and MIT license.
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in argx, as defined in the Apache License 2.0, is licensed under
those same terms, without any additional terms or conditions.
By submitting a contribution, you represent that you have the right to submit the contributed material under those terms.
If your contribution incorporates or is derived from third-party source material, make that provenance clear in the pull request and preserve any applicable license, copyright, and attribution requirements.