miller/docs/src/contributing.md.in
2026-07-05 10:35:41 -04:00

32 lines
1.4 KiB
Markdown

# How to contribute
## Community discussions
You can ask questions -- or answer them! -- following the links on the [Community](community.md) page.
## Documentation improvements
Pre-release Miller documentation is at
[https://github.com/johnkerl/miller/tree/main/docs](https://github.com/johnkerl/miller/tree/main/docs).
Instructions for modifying, viewing, and submitting PRs for these are in [README-docs.md](https://github.com/johnkerl/miller/blob/main/README-docs.md).
Once PRs are merged, readthedocs creates
[https://miller.readthedocs.io](https://miller.readthedocs.io) using the following configs:
* [https://readthedocs.org/projects/miller](https://readthedocs.org/projects/miller)
* [https://readthedocs.org/projects/miller/builds](https://readthedocs.org/projects/miller/builds)
* [https://github.com/johnkerl/miller/settings/hooks](https://github.com/johnkerl/miller/settings/hooks)
## Testing a development build
To try out unreleased changes, either build from source via [Building from source](build.md), or
grab a recent binary from
[https://github.com/johnkerl/miller/actions](https://github.com/johnkerl/miller/actions) (latest
build → *Artifacts*). Then use it as you normally would, and file an issue at
[https://github.com/johnkerl/miller/issues](https://github.com/johnkerl/miller/issues) if you hit
something.
## Source-code mods
Please see the repo's [CONTRIBUTING.md](https://github.com/johnkerl/miller/blob/main/CONTRIBUTING.md).