Skip to content

Commit 547b23d

Browse files
Contributing
1 parent 9d68604 commit 547b23d

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

CONTRIBUTING.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing
2+
3+
## Getting Started
4+
5+
1. Install [asdf](https://asdf-vm.com)
6+
2. Install the asdf Ruby plugin
7+
8+
```bash
9+
asdf plugin add ruby https://github.com/asdf-vm/asdf-ruby.git # Visit that repository to see installation prerequisites
10+
```
11+
12+
3. Run `asdf install` to install the version of Ruby specified in the [.ruby-version](.ruby-version) file
13+
4. Run `bundle install` to install the Ruby dependencies
14+
15+
## Running the tests
16+
17+
```bash
18+
bundle exec rspec
19+
```
20+
21+
## Running the linter
22+
23+
```bash
24+
bundle exec rubocop
25+
```
26+
27+
## Formatting
28+
29+
```bash
30+
bundle exec rubocop -a
31+
```

0 commit comments

Comments
 (0)