There are many ways to contribute to Quickwit. Code contributions are welcome of course, but also bug reports, feature requests, and evangelizing are as valuable.
Check if your issue is already listed on github. If it is not, create your own issue.
Please add the following phrase at the end of your commit Closes #<Issue Number>
.
It will automatically link your PR in the issue page. Also, once your PR is merged, it will
close the issue. If your PR only partially addresses the issue and you would like to
keep it open, just write See #<Issue Number>
.
Feel free to send your contribution in an unfinished state to get early feedback. In that case, simply mark the PR with the tag [WIP] (standing for work in progress).
Quickwit is an open source project licensed under AGPLv3. It is also distributed under a commercial license by Quickwit, Inc.
Contributors are required to sign a Contributor License Agreement. The process is simple and fast. Upon your first pull request, you will be prompted to sign our CLA by visiting this link.
When you submit a pull request to the project, the CI system runs several verification checks. After your PR is merged, a more exhaustive list of tests will be run.
You will be notified by email from the CI system if any issues are discovered, but if you want to run these checks locally before submitting PR or in order to verify changes you can use the following commands in the root directory:
make test-all
.make fix
. Alternatively, run make -k test-all docker-compose-down
to tear down the Docker services after running all the tests.make build-docs
.npm install -g yarn
GitHub Codespaces provides a fully configured development environment in the cloud, making it easy to get started with Quickwit development. By clicking the badge above, you can create a codespace with all the necessary tools installed and configured.
Run make test-all
to run all tests.
make test-all
- starts necessary Docker services and runs all tests.make -k test-all docker-compose-down
- the same as above, but tears down the Docker services after running all the tests.make fmt
- runs formatter, this command requires the nightly toolchain to be installed by running rustup toolchain install nightly
.make fix
- runs formatter and clippy checks.make typos
- runs the spellcheck tool over the codebase. (Install by running cargo install typos
)make build-docs
- builds docs.make docker-compose-up
- starts Docker services.make docker-compose-down
- stops Docker services.make docker-compose-logs
- shows Docker logs.quickwit
subdirectory of the project and create a data directory qwdata
there if it doesn't existcargo r run --config ../config/quickwit.yaml
yarn --cwd quickwit-ui install
and yarn --cwd quickwit-ui start
http://localhost:3000/ui
if it doesn't open automaticallyyarn --cwd quickwit-ui install
and yarn --cwd quickwit-ui test
in the quickwit
directorycargo r run --service searcher --config ../config/quickwit.yaml
yarn --cwd quickwit-ui e2e-test
make docker-compose-up
to launch all the services or make docker-compose-up DOCKER_SERVICES=kafka,postgres
to launch a subset of services.make docker-compose-up DOCKER_SERVICES=jaeger
OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317
QW_ENABLE_OPENTELEMETRY_OTLP_EXPORTER=true
cargo install tokio-console
.RUSTFLAGS="--cfg tokio_unstable" cargo install --path . --features tokio-console
QW_ENABLE_TOKIO_CONSOLE=1 quickwit index ...
tokio-console
.Currently, we use cross to build Quickwit binaries for different architectures.
For this to work, we've had to customize the docker images cross uses. These customizations can be found in docker files located in the ./cross-images
folder. To make cross take into account any change on those
docker files, you will need to build and push the images on Docker Hub by running make cross-images
.
We also have nightly builds that are pushed to Docker Hub. This helps continuously check that our binaries are still built even with external dependency updates. Successful builds let you access the artifacts for the next three days. Release builds always have their artifacts attached to the release.
Each merge on the main
branch triggers the build of a new Docker image available on DockerHub at quickwit/quickwit:edge
. Tagging a commit also creates a new image quickwit/quickwit:<tag name>
if the tag name starts with v*
or qw*
. The Docker images are based on Debian.
As the react UI is embedded in the rust binary, we need to build the react app before building the binary. Hence make cross-image
depends on the command build-ui
.
The following Quickwit installation command curl -L https://install.quickwit.io | sh
always installs the latest stable version of quickwit. To make it easier in installing and testing new (alpha, beta, rc) releases, you can manually pull and execute the script as ./install.sh --allow-any-latest-version
. This will force the script to install any latest available release package.
Quickwit documentation is located in the docs directory.
The CLI doc page is partly generated by a script. To update it, first run the script:
cargo run --bin generate_markdown > ../docs/reference/cli_insert.md
Then manually edit the doc page to update it and delete the generated file. There are two comments to indicate where you want to insert the new docs and where it ends:
[comment]: <> (Insert auto generated CLI docs from here.)
...docs to insert...
[comment]: <> (End of auto generated CLI docs.)
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。