Skip to content

Commit ecbf136

Browse files
committed
update Readme
1 parent 37b8bc3 commit ecbf136

File tree

2 files changed

+32
-4
lines changed

2 files changed

+32
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,15 @@ SkillRX is one of many projects initiated and run by Ruby for Good. You can find
1111
# Welcome Contributors!
1212
Thank you for checking out our work. We are in the process of setting up the repository, roadmap, values, and contribution guidelines for the project. We will be adding issues and putting out a call for contributions soon.
1313

14+
# Setup
15+
16+
Clone this repo and run `bin/setup`. Run `bin/dev` or `bin/server` (if you like Overmind) to start working with app.
17+
1418
# Testing
1519

1620
This project uses:
1721
* `rspec` for testing
1822
* `shoulda-matchers` for expectations
1923
* `factory_bot` for making records
2024

21-
To run tests execute
22-
```
23-
bin/rspec
24-
```
25+
To run tests simply use `bin/rspec`. You can also you `bin/quality` to check for code style issues.

bin/quality

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
#!/usr/bin/env ruby
2+
3+
require 'pathname'
4+
require 'fileutils'
5+
include FileUtils
6+
7+
# path to your application root.
8+
APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
9+
10+
def system!(*args)
11+
system(*args) || abort("\n== Command #{args} failed ==")
12+
end
13+
14+
# rubocop
15+
chdir APP_ROOT do
16+
system! 'bin/rubocop --config .rubocop.yml'
17+
end
18+
19+
# brakeman
20+
chdir APP_ROOT do
21+
system! 'bin/brakeman --no-pager --no-progress'
22+
end
23+
24+
# js
25+
chdir APP_ROOT do
26+
system! 'bin/importmap audit'
27+
end

0 commit comments

Comments
 (0)