Skip to content

Adds requirements specifying need for Libyaml on Linux. Closes: #121 #122

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Adds requirements specifying need for Libyaml on Linux. Closes: #121 #122

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5fe6c07
Updated CONTRIBUTING.md to show requirements.
FiggyFoxFunc May 20, 2025
fcfffb3
removed Gemfile.lock
FiggyFoxFunc May 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ Here's what you need to do:
- [Make sure the test suite passes on GitHub Actions and make any necessary changes to your branch to bring it to green.](#continuous-integration).
- Check out the [Help Wanted](#help-wanted) section for suggestions on how to support Skunk.

## Requirements
For Ruby ruby 3.0.2p107 on the Linux distro POP-OS install the following:
Copy link
Member

@JuanVqz JuanVqz Jun 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I don't mean to be a blocker, but a couple of observations:

  • Pop!_OS seems to be the official name
  • I think Ruby ruby 3.0.2p107 is kind of specific. what do you think on saying Ruby 3.0 and up?
Suggested change
For Ruby ruby 3.0.2p107 on the Linux distro POP-OS install the following:
For a Linux distro called Pop!_OS, running Ruby 3.0 and up might require installing the following packages:

```bash
sudo apt install libyaml-dev
```

## Setting up your environment
To install the dependencies, run:

Expand Down Expand Up @@ -81,4 +87,4 @@ The SkunkScore of a module should be the average of the SkunkScores of all of it

Feel free to review and submit your suggestions to improve the method [RubyCritic::AnalysedModule#skunk_score](https://github.com/fastruby/skunk/blob/main/lib/skunk/rubycritic/analysed_module.rb#L33).

📘 Read [Escaping The Tar Pit: Introducing Skunk v0.3.2 at RubyConf 2019](https://www.fastruby.io/blog/code-quality/escaping-the-tar-pit-at-rubyconf.html) and [Churn vs. Complexity vs. Code Coverage](https://www.fastruby.io/blog/code-quality/churn-vs-complexity-vs-coverage.html) for more details about the `skunk_score` method.
📘 Read [Escaping The Tar Pit: Introducing Skunk v0.3.2 at RubyConf 2019](https://www.fastruby.io/blog/code-quality/escaping-the-tar-pit-at-rubyconf.html) and [Churn vs. Complexity vs. Code Coverage](https://www.fastruby.io/blog/code-quality/churn-vs-complexity-vs-coverage.html) for more details about the `skunk_score` method.