CONTRIBUTING.md

Contributing to zbus

We welcomes contribution from everyone in the form of suggestions, bug reports, merge requests, and feedback. This document gives some guidance if you are thinking of helping us.

Please reach out here in a Gitlab (or Github) issue, or in the #zbus:matrix.org Matrix room if we can do anything to help you contribute.

Submitting bug reports and feature requests

You can create issues here. When reporting a bug or asking for help, please include enough details so that the people helping you can reproduce the behavior you are seeing. For some tips on how to approach this, read about how to produce a Minimal, Complete, and Verifiable example.

When making a feature request, please make it clear what problem you intend to solve with the feature, any ideas for how the crate in question could support solving that problem, any possible alternatives, and any disadvantages.

Submitting Merge Requests (or Pull Requests on Github)

Same rules apply here as for bug reports and feature requests. Plus:

• We prefer atomic commits. Please read this excellent blog post for more information, including the rationale.
• Please try your best to follow these guidelines for commit messages.
• Add details to each commit about the changes it contains. MR description is for summarizing the overall changes in the MR, while commit logs are for describing the specific changes of the commit in question.
• When addressesing review comments, fix the existing commits in the MR (rather than adding additional commits) and force push (as in git push -f) to your branch. You may find git-absorb and git-revise extremely useful, especially if you're not very familiar with interactive rebasing and modifying commits in git.

Legal Notice

When contributing to this project, you implicitly declare that you:

• have authored 100% of the content.
• have the necessary rights to the content.
• agree to providing the content under the project's license.

Github

Although Gitlab is our main and preferred code repository host, the Github mirror can also be used to submit PRs and issues. Although PRs on Github requires us to merge manually, we will gladly do that for you. :-)

Merging PRs from Github (for maintainers only)

Here is how to manually merge PRs from Github:

# If you haven't yet added the remote
git remote add gh [email protected]:zeenix/zbus.git
git remote update
git checkout main # If you aren't on main already
git fetch gh pull/PULL_ID/head:BRANCH_NAME # You choose the BRANCH_NAME
git merge --no-ff BRANCH_NAME -m "Merge Github PR PULL_ID"
git push origin main
# Only needed until https://gitlab.freedesktop.org/freedesktop/freedesktop/-/issues/286 is resolved
git push gh main

Running the test suite

We encourage you to check that the test suite passes locally before submitting a merge request with your changes. If anything does not pass, typically it will be easier to iterate and fix it locally than waiting for the CI servers to run tests for you.

# Run the full test suite, including doc test and compile-tests
cargo test --all-features

Also please ensure that code is formatted correctly by running:

cargo +nightly fmt --all

and clippy doesn't see anything wrong with the code:

cargo clippy -- -D warnings

Please not that there are times when clippy is wrong and you know what you are doing. In such cases, it's acceptable to tell clippy to ignore the specific error or warning in the code.

If you intend to contribute often or think that's very likely, we recommend you setup the following git hooks:

• Pre-commit hook that goes in the .git/hooks/pre-commit file:

  if ! which rustup &> /dev/null; then
      curl https://sh.rustup.rs -sSf  | sh -s -- -y
      export PATH=$PATH:$HOME/.cargo/bin
      if ! which rustup &> /dev/null; then
          echo "Failed to install rustup"
      fi
  fi
  
  if ! rustup component list --toolchain nightly|grep 'rustfmt-preview.*(installed)' &> /dev/null; then
      echo "Installing nightly rustfmt.."
      rustup component add rustfmt-preview --toolchain nightly
      echo "rustfmt installed."
  fi
  
  echo "--Checking style--"
  cargo +nightly fmt --all -- --check
  if test $? != 0; then
      echo "--Checking style fail--"
      echo "Please fix the above issues, either manually or by running: cargo +nightly fmt --all"
  
      exit -1
  else
      echo "--All very stylish 😎--"
  fi

• Pre-push hook that goes in the .git/hooks/pre-push file:

  if ! which rustup &> /dev/null; then
      curl https://sh.rustup.rs -sSf  | sh -s -- -y
      export PATH=$PATH:$HOME/.cargo/bin
      if ! which rustup &> /dev/null; then
          echo "Failed to install rustup"
      fi
  fi
  
  if ! rustup component list --toolchain stable|grep 'clippy.*(installed)' &> /dev/null; then
      echo "Installing clippy.."
      rustup component add clippy
      echo "clippy installed."
  fi
  
  echo "--Analysing code 🔍--"
  cargo clippy -- -D warnings
  if test $? != 0; then
      echo "--Issues with code. See warnings/errors above--"
  
      exit -1
  else
      echo "--Code looks good 👍--"
  fi

Adding public API

Assert auto traits on items

Please make sure to add assert_impl_all!() macros to ensure that accidental changes to auto trait implementations like Send, Sync, and Unpin can be detected easily. You should use the existing code to see how it is done with all of the current items already. For further information see the Rust API Guidelines on C-SEND-SYNC.

Conduct

In all zbus-related forums, we follow the Rust Code of Conduct. For escalation or moderation issues please contact Zeeshan ([email protected]) instead of the Rust moderation team.