zellij-org/zellij
1
1
Fork 0
mirror of https://github.com/zellij-org/zellij.git synced 2024-11-23 19:10:09 +03:00
Code Issues Projects Releases Wiki Activity
23e0b8adf1
zellij/CONTRIBUTING.md
Brooks J Rady d2a7d100ac docs(build): documented the new build system
2021-04-13 16:06:04 +01:00

3.9 KiB
Raw Blame History

Contributing to Zellij

Thanks for considering to contribute to Zellij!

First: if you're unsure or afraid of anything, just ask on our Discord server or submit the issue or pull request anyway. You won't be yelled at for giving it your best effort. The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contributions, and don't want a wall of rules to get in the way of that.

Code of Conduct

Before contributing please read our Code of Conduct which all contributors are expected to adhere to.

Building

To build Zellij, we're using cargo-make – you can install it by running cargo install --force cargo-make.

Here are some of the commands currently supported by the build system:

# Format code, build, then run tests
cargo make
# You can also perform these actions individually
cargo make format
cargo make build
cargo make test
# Run Zellij (optionally with a non-default layout)
cargo make run
cargo make run strider
# Run Clippy (potentially with additional options)
cargo make clippy
cargo make clippy -W clippy::pedantic
# Install Zellij to some directory
cargo make install /path/of/zellij/binary
# Publish the zellij and zellij-tile crates
cargo make publish

To run install or publish, you'll need binaryen --version > 97, for it's command wasm-opt.

Looking for something to work on?

If you are new contributor to Zellij going through beginners should be a good start or you can join our public Discord server, we would be happy to help finding something interesting to work on and guide through.

Filing Issues

Bugs and enhancement suggestions are tracked as GitHub issues.

Lacking API for plugin in Zellij?

If you have a plugin idea, but Zellij still doesn't have API required to make the plugin consider opening an issue and describing your requirements.

How Do I Submit A (Good) Bug Report?

After you've determined which repository your bug is related to and that the issue is still present in the latest version of the master branch, create an issue on that repository and provide the following information:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Explain which behavior you expected to see instead and why.
  • Describe the exact steps to reproduce the problem in as many details as necessary.
  • When providing code samples, please use code blocks.

How Do I Submit A (Good) Enhancement Suggestion?

Instructions are similar to those for bug reports. Please provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a description of the suggested enhancement in as many details as necessary.
  • When providing code samples, please use code blocks.

Submitting Pull Requests

Instructions are similar to those for bug reports. Please provide the following information:

  • If this is not a trivial fix, consider creating an issue to discuss first and later link to it from the PR.
  • Use a clear and descriptive title for the pull request.
  • Provide a description of the changes in as many details as necessary.

Before submitting your pull request, also make sure that the following conditions are met:

  • Your new code adheres to the code style through running cargo fmt.
  • Your new code passes all existing and new tests through running cargo test.