Skip to content

Commit 6b79090

Browse files
committed
clarify dependency installation for contributing
1 parent cf36b3f commit 6b79090

File tree

3 files changed

+12
-7
lines changed

3 files changed

+12
-7
lines changed

CONTRIBUTING.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,22 @@ Here's a quick guide for contributing:
1010

1111
1. Fork the repo.
1212

13-
2. Run the tests. We only take pull requests with passing tests, and it's great
13+
1. Make sure you have ImageMagick and Ghostscript installed. See [this section]
14+
(./README.md#image-processor) of the README.
15+
16+
1. Run the tests. We only take pull requests with passing tests, and it's great
1417
to know that you have a clean slate: `bundle && bundle exec rake`
1518

16-
3. Add a test for your change. Only refactoring and documentation changes
19+
1. Add a test for your change. Only refactoring and documentation changes
1720
require no new tests. If you are adding functionality or fixing a bug, we need
1821
a test!
1922

20-
4. Make the test pass.
23+
1. Make the test pass.
2124

22-
5. Mention how your changes affect the project to other developers and users in
25+
1. Mention how your changes affect the project to other developers and users in
2326
the `NEWS.md` file.
2427

25-
6. Push to your fork and submit a pull request.
28+
1. Push to your fork and submit a pull request.
2629

2730
At this point you're waiting on us. We like to at least comment on, if not
2831
accept, pull requests within seven business days (most of the work on Paperclip

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -944,7 +944,7 @@ guidelines:
944944
about writing tests for paperclip, please open a
945945
[GitHub issue](https://github.com/thoughtbot/paperclip/issues/new).
946946

947-
Please see `CONTRIBUTING.md` for more details on contributing and running test.
947+
Please see [`CONTRIBUTING.md`](./CONTRIBUTING.md) for more details on contributing and running test.
948948

949949
Thank you to all [the contributors](https://github.com/thoughtbot/paperclip/graphs/contributors)!
950950

lib/paperclip/errors.rb

+3-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ class MissingRequiredValidatorError < Paperclip::Error
1919
end
2020

2121
# Will be thrown when ImageMagic cannot determine the uploaded file's
22-
# metadata, usually this would mean the file is not an image.
22+
# metadata, usually this would mean the file is not an image. If you are
23+
# consistently receiving this error on PDFs make sure that you have
24+
# installed Ghostscript.
2325
class NotIdentifiedByImageMagickError < Paperclip::Error
2426
end
2527

0 commit comments

Comments
 (0)