Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: improve HACKING.md #484

Merged
merged 1 commit into from
Jan 16, 2025

Conversation

chanchiwai-ray
Copy link
Contributor

Description

Add some missing dependencies for running unit test and static checks locally.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • CleanCode (Code refactor, test updates, does not introduce functional changes)
  • Documentation update (Doc only change)

How Has This Been Tested?

Created a LXD VM and install the following dependencies, and make sure make check-unit and make check-static can run without issues.

sudo apt update
sudo apt install gcc make shellcheck 
sudo add-apt-repository ppa:dqlite/dev 
sudo apt install libdqlite-dev
sudo snap install go --classic
export PATH=$PATH:$HOME/go/bin

git clone https://github.com/canonical/microceph.git
cd microceph/microceph
make

Contributor's Checklist

Please check that you have:

  • self-reviewed the code in this PR.
  • added code comments, particularly in hard-to-understand areas.
  • updated the user documentation with corresponding changes.
  • added tests to verify effectiveness of this change.

Add some missing dependencies for running unit test and static checks
locally.

Signed-off-by: Chi Wai Chan <[email protected]>
@chanchiwai-ray chanchiwai-ray marked this pull request as ready for review December 20, 2024 08:40
Copy link
Contributor

@UtkarshBhatthere UtkarshBhatthere left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @chanchiwai-ray

@UtkarshBhatthere UtkarshBhatthere merged commit 2e22e93 into canonical:main Jan 16, 2025
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants