Skip to content

Commit 6ea68fe

Browse files
Adds requirements specifying need for Libyaml on Linux. Closes: #121 (#122)
* Updated CONTRIBUTING.md to show requirements. * removed Gemfile.lock * Apply suggestions from code review --------- Co-authored-by: Juan Vásquez <[email protected]>
1 parent a459298 commit 6ea68fe

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ Here's what you need to do:
1414
- [Make sure the test suite passes on GitHub Actions and make any necessary changes to your branch to bring it to green.](#continuous-integration).
1515
- Check out the [Help Wanted](#help-wanted) section for suggestions on how to support Skunk.
1616

17+
## Requirements
18+
For a Linux distro called Pop!_OS, running Ruby 3.0 and up might require installing the following packages:
19+
```bash
20+
sudo apt install libyaml-dev
21+
```
22+
1723
## Setting up your environment
1824
To install the dependencies, run:
1925

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

8288
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).
8389

84-
📘 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.
90+
📘 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.

0 commit comments

Comments
 (0)