summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
AgeCommit message (Collapse)Author
2023-02-13chore(build): make the singlepass compiler opt-in through flags (#2146)m-lima
2023-02-07chore(development): use singlepass in debug mode (#2134)m-lima
* 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
2022-12-20chore(repo): remove nix support (#2038)Aram Drevekenin
2022-12-17WIP: Use `xtask` as build system (#2012)har7an
* 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
2022-11-13update log path (#1927)哇呜哇呜呀咦耶
2022-11-09docs: Improve error handling docs (#1919)har7an
* 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
2022-10-18docs: Describe how to handle Options as errors (#1805)har7an
* 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.
2022-08-01docs(contributing): document logging (#1627)Aram Drevekenin
* docs(contributing): document logging * docs(contributing): add logging example
2022-07-29fix(readme): cargo install instructions (#1616)a-kenji
2022-07-10chore(docs): add more matrix links (#1581)a-kenji
2022-03-04docs(contrib): fix markupa-kenji
2022-03-04docs(contributing): add a small `nix` section (#1172)a-kenji
2022-02-27docs(add): `podman` as alternative to `docker` (#1137)a-kenji
2022-02-27fix(docs): add information about clippy lints (#1126)Ken Matsui
2022-02-24fix(docs): fix a grammatical error in `CONTRIBUTING.md` (#1070)Ken Matsui
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.
2021-11-30fix: Update CONTRIBUTING.md (#909)Joseph Post
added a newline to fix URLs
2021-11-09fix(docs): Add additional e2e test instruction for macOS users (including ↵Ken Matsui
m1) (#845)
2021-10-31fix(docs): fix wrong arguments for `cargo make run` given in CONTRIBUTING.md ↵Ken Matsui
(#819)
2021-09-29docs(contributing): clean up languageAram Drevekenin
2021-06-29Add new dependencies to `CONTRIBUTING.md`a-kenji
2021-06-21Add e2e tests (#582)Aram Drevekenin
* 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
2021-06-10docs(contributing): add the invite link to the discord server (#570)Matthias
2021-05-19chore(docs): Fix referencesa-kenji
* `xrdb` is not included currently
2021-05-05wrapped lines in CONTRIBUTING.mdNKGoc
2021-05-05simplificationsNKGoc
2021-05-02docs(contributing): Update Dependenciesa-kenji
2021-04-14docs(build): update CONTRIBUTING.mdBrooks J Rady
2021-04-13fix(clippy): get ci passing againBrooks J Rady
2021-04-13docs(build): documented the new build systemBrooks J Rady
2021-02-24Doc build (#207)a-kenji
* docs(build): Add information about binaryen dep * docs(build): Add information about binaryen dep
2021-02-16Add updated build instructionsBrooks J Rady
2021-02-10Update references of mosaic to Zellij in md fileshenil
2021-02-05Follow Conventional commits where necessaryhenil
2021-02-04change heading levelhenil
2021-02-04fix linkshenil
2021-02-04removed CHANGELOG for now and added some more detailshenil
2021-01-31Add initial issue template and CONTRIBUTING.mdhenil