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

add simple contribution guide #54

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ group :development do
end

group :test do
gem 'rexml', '~> 3.2', '>= 3.2.4'
gem 'minitest', '~> 5.14', require: 'minitest/autorun'
gem 'minitest-reporters', '~> 1.4'
gem 'mocha', '~> 1.11', require: 'mocha/minitest'
Expand Down
2 changes: 2 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ GEM
pry (~> 0.13.0)
public_suffix (4.0.6)
rake (13.0.1)
rexml (3.2.5)
ruby-progressbar (1.10.1)
simplecov (0.19.1)
docile (~> 1.1)
Expand All @@ -47,6 +48,7 @@ DEPENDENCIES
mocha (~> 1.11)
pry-byebug
rake (~> 13.0)
rexml (~> 3.2, >= 3.2.4)
simplecov (~> 0.19)
webmock (~> 3.10)

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ If you're using an Enterprise account, you can call the `gh-host <host>` command
You can submit your bug reports or feature requests at:
https://github.com/edgarjs/alfred-github-repos/issues

If you want to submit a Pull Request, please follow these simple guides:
If you want to submit a Pull Request, please read [CONTRIBUTING](./docs/CONTRIBUTING.md) then follow these simple guides:

1. Add a detailed description of what you're changing and why.
2. Add necessary unit tests that cover your changes.
Expand Down
13 changes: 13 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Run tests

```sh
rbenv global 3.0.6
bundle install
bundle exec rake
```

# Make Alfred package

```sh
./bin/package
```