aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md (follow)
Commit message (Collapse)AuthorAge
* fix(build): remove manpage, honor CARGO_TARGET_DIR, add cargo argument ↵Aram Drevekenin2026-07-30
| | | | | | | passthrough, remove clippy (#5426) * fix(build): remove manpage, honor CARGO_TARGET_DIR, add cargo argument passthrough, remove clippy * add pr
* Fish completion delete session (#5317)Zykino2026-06-30
| | | | | | | | | | | | | | | | | | * Add session completion for "delete-session" Close #5316 * Force default value for CARGO_TARGET_DIR Since we did not approved and maintain #2611 * Move `xtask run`'s specific output to stderr That way command output can be redirected without garbage e.g.: `cargo xtask run -- setup --generate-completion fish > ~/.config/fish/completions/zellij.fish` --------- Co-authored-by: Zykino <3809938+Zykino@users.noreply.github.com>
* fix(e2e): stabilize tests and support Apple Silicon local dev (#4952)Thomas Linford2026-04-01
| | | | | | | | | | - cross-compile musl binary on macOS via cargo-zigbuild, with arch-independent symlink so snapshots are stable across x86_64 and aarch64 - kill_running_sessions() now calls stop_zellij() instead of start_zellij(), eliminating 3s startup per test - prevent steps from firing prematurely by tightening completion conditions and adding re-send logic for garbled keys
* docs(CONTRIBUTING): Describe rust toolchain versioning policy (#4585)har7an2026-01-07
| | | | | | | | | | | * docs(CONTRIBUTING): Describe rust toolchain versioning policy and mention the lack of a MSRV. This should allow people to discover how toolchain updates are handled, even though there currently isn't much of an explanation. * docs(CHANGELOG): Mention PR #4585 which describes the Rust toolchain versioning policy.
* docs(contributing): update PR statement wordingAram Drevekenin2025-03-10
|
* dependencies: switch from Wasmer to Wasmtime (#3349)bjorn32024-06-28
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Remove ForeignFunctionEnv wrapper around PluginEnv This will enable PluginEnv to be the Store context when migrating to Wasmtime. * Pass PluginEnv by value to load_plugin_instance This will allow removing the Clone impl from PluginEnv when migrating to Wasmtime as required by the missing Clone impl on Wasmtime's WasiCtx. * Avoid passing a Store around when an Engine is enough * Pass PluginEnv to the wasi read/write functions Wasmtime requires storing the read/write end of the pipe outside of the WasiCtx. Passing PluginEnv to these functions allows storing them in the PluginEnv. * Migrate to Wasmtime * Switch from wasi-common to wasmtime-wasi * Reduce verbosity of wasmtime_wasi logs * Increase startup delay To wait for all plugins to be compiled. * Disable some wasmtime features * Update to Wasmtime 21.0.1
* chore(repo): update build instructionsAram Drevekenin2023-08-28
|
* docs(contributing): status of contributionsAram Drevekenin2023-06-14
|
* Feature: simulate publishing (#2194)har7an2023-03-06
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * xtask: Add arguments to `publish` that allow specifying a custom git remote to push to and a custom cargo registry to publish packages to. * xtask/publish: Don't release `xtask` subcrate because it's not meant to be released at all. * xtask/publish: Add status messages to publish so we see what crate is currently being published, too. * xtask/publish: Disable default features on `zellij` because otherwise it tries to pick up the debug builds of the plugins, which aren't part of released version of `zellij utils`. * xtask/publish: Fix handling of custom registry * docs: Add `RELEASE.md` which explains how to simulate a zellij release. * xtask: Apply rustfmt * xtask: Remove `wasm-opt` from build steps because recent versions cause havoc in the release process in GitHub pipelines and it's primary goal is to only reduce binary size. Current rust versions seem to produce very compact wasm binaries themselves, though. * .github: Don't install wasm-opt in workflows
* chore(build): make the singlepass compiler opt-in through flags (#2146)m-lima2023-02-13
|
* chore(development): use singlepass in debug mode (#2134)m-lima2023-02-07
| | | | | | | | | | | | | | | | | | | | | | * Add new feature flags * Use singlepass in debug mode * Use Cow to avoid unnecessary copies - Instead of removing and reinserting into the memory cache, use Cow to model both owned an borrowed data - Log at debug-level the time to compile/load a wasm module - A little clippy drive-by on touched files * Satisfy the assumption from zellij-utils/src/consts.rs for target-dir * Allow forcing cranlift in debug mode * Remove deprecated comments * PR comment: typo * Remove extras
* chore(repo): remove nix support (#2038)Aram Drevekenin2022-12-20
|
* WIP: Use `xtask` as build system (#2012)har7an2022-12-17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * xtask: Implement a new build system xtask is a cargo alias that is used to extend the cargo build system with custom commands. For an introduction to xtask, see here: https://github.com/matklad/cargo-xtask/ The idea is that instead of writing makefiles, xtask requires no additional dependencies except `cargo` and `rustc`, which must be available to build the project anyway. This commit provides a basic implementation of the `build` and `test` subcommands. * xtask/deps: Add 'which' * xtask/test: Handle error when cargo not found * xtask/flags: Add more commands to perform different useful tasks. Includes: - clippy - format - "make" (composite) - "install" (composite) Also add more options to `build` to selectively compile plugins or leave them out entirely. * xtask/main: Return error when cargo not found * xtask/build: Add more subtasks - `wasm_opt_plugins` and - `manpage` that perform other build commands. Add thorough documentation on what each of these does and also handle the new `build` cli flags appropriately. * xtask/clippy: Add job to run clippy * xtask/format: Add job to run rustfmt * xtask/pipeline: Add composite commands that perform multiple atomic xtask commands sequentially in a pipeline sort of fashion. * xtask/deps: Pin dependencies * xtask/main: Integrate new jobs and add documentation. * xtask: Implement 'dist' which performs an 'install' and copies the resulting zellij binary along with some other assets to a `target/dist` folder. * cargo: Update xflags version * xtask: Measure task time, update tty title * xtask: Update various tasks * xtask: wasm-opt plugins in release builds automatically. * xtask/build: Copy debug plugins to assets folder * xtask: Add 'run' subcommand * xtask: Add arbitrary args to test and run * xtask: Rearrange CLI commands in help * xtask: Add deprecation notice * docs: Replace `cargo make` with `xtask` * github: Use `xtask` in workflows. * xtask: Add support for CI commands * xtask: Streamline error handling * github: Use new xtask commands in CI * xtask: Add 'publish' job * xtask/publish: Add retry when publish fails * xtask: Apply rustfmt * xtask: Refine 'make' deprecation warning * xtask: add task to build manpage * contributing: Fix e2e commands * xtask/run: Add missing `--` to pass all arguments following `xtask run` directly to the zellij binary being run. * xtask: Stay in invocation dir and make all tasks that need it change to the project root dir themselves. * xtask/run: Add `--data-dir` flag which will allow very quick iterations when not changing the plugins between builds. * xtask/ci: Install dependencies without asking * utils: Allow including plugins from target folder * utils/assets: Reduce asset map complexity * utils/consts: Update asset map docs * xtask: Fix plugin includes * xtask/test: Build plugins first because the zellij binary needs to include the plugins. * xtask/test: Fix formatting * xtask: Add notice on how to disable it
* update log path (#1927)哇呜哇呜呀咦耶2022-11-13
|
* docs: Improve error handling docs (#1919)har7an2022-11-09
| | | | | | | | * docs: Improve error handling docs and add more TL;DRs and new sections about handling specific errors, and logging errors. * contributing: Add more coding tips
* docs: Describe how to handle Options as errors (#1805)har7an2022-10-18
| | | | | | | | | | | | | | * docs: Describe how to handle Options as errors * CONTRIBUTING: Add tips for code contributions which will be home to condensed tips and best-practices around the zellij code. Currently explains to prefer returning `Result` types instead of `unwrap`ing on them. The tips in here are meant to be short, concise guides that allow the user to get started without a lot of reading. The individual tips can (and should) be supplemented with links to "further reading" where the topic at hand is explained in greater detail.
* docs(contributing): document logging (#1627)Aram Drevekenin2022-08-01
| | | | | * docs(contributing): document logging * docs(contributing): add logging example
* fix(readme): cargo install instructions (#1616)a-kenji2022-07-29
|
* chore(docs): add more matrix links (#1581)a-kenji2022-07-10
|
* docs(contrib): fix markupa-kenji2022-03-04
|
* docs(contributing): add a small `nix` section (#1172)a-kenji2022-03-04
|
* docs(add): `podman` as alternative to `docker` (#1137)a-kenji2022-02-27
|
* fix(docs): add information about clippy lints (#1126)Ken Matsui2022-02-27
|
* fix(docs): fix a grammatical error in `CONTRIBUTING.md` (#1070)Ken Matsui2022-02-24
| | | | The verb `consider` is followed by a gerund form verb. When you want to follow `consider` by to-infinitive verb, you should use it with a pronoun.
* fix: Update CONTRIBUTING.md (#909)Joseph Post2021-11-30
| | | added a newline to fix URLs
* fix(docs): Add additional e2e test instruction for macOS users (including ↵Ken Matsui2021-11-09
| | | | m1) (#845)
* fix(docs): fix wrong arguments for `cargo make run` given in CONTRIBUTING.md ↵Ken Matsui2021-10-31
| | | | (#819)
* docs(contributing): clean up languageAram Drevekenin2021-09-29
|
* Add new dependencies to `CONTRIBUTING.md`a-kenji2021-06-29
|
* Add e2e tests (#582)Aram Drevekenin2021-06-21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * feature(tests): e2e tests * chore(build): github action * chore(build): fix workflow * chore(build): fix workflow * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * work * working * working * working * bring back the proper errors * make e2e flow run properly * style(fmt): make rustfmt happy * style(fmt): make rustfmt happy * run on everything just to test the workflow * bring back running behaviour on workflow
* docs(contributing): add the invite link to the discord server (#570)Matthias2021-06-10
|
* chore(docs): Fix referencesa-kenji2021-05-19
| | | | * `xrdb` is not included currently
* wrapped lines in CONTRIBUTING.mdNKGoc2021-05-05
|
* simplificationsNKGoc2021-05-05
|
* docs(contributing): Update Dependenciesa-kenji2021-05-02
|
* docs(build): update CONTRIBUTING.mdBrooks J Rady2021-04-14
|
* fix(clippy): get ci passing againBrooks J Rady2021-04-13
|
* docs(build): documented the new build systemBrooks J Rady2021-04-13
|
* Doc build (#207)a-kenji2021-02-24
| | | | | * docs(build): Add information about binaryen dep * docs(build): Add information about binaryen dep
* Add updated build instructionsBrooks J Rady2021-02-16
|
* Update references of mosaic to Zellij in md fileshenil2021-02-10
|
* Follow Conventional commits where necessaryhenil2021-02-05
|
* change heading levelhenil2021-02-04
|
* fix linkshenil2021-02-04
|
* removed CHANGELOG for now and added some more detailshenil2021-02-04
|
* Add initial issue template and CONTRIBUTING.mdhenil2021-01-31