kotovalexarian-likes-github
/
carrierwaveuploader--carrierwave
mirror of https://github.com/carrierwaveuploader/carrierwave.git
1
0
Fork 0
Code Releases Activity

Create CONTRIBUTING.md 

Dedicated document for better GitHub integration.
See https://github.com/blog/1184-contributing-guidelines.

remove contributing section in README
This commit is contained in:
David Radcliffe 2012-12-06 05:20:56 -08:00
parent 22c99ff2c4
commit d24df7ac73
2 changed files with 39 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,38 @@
# Contributing to CarrierWave
CarrierWave thrives on a large number of [contributors](https://github.com/jnicklas/carrierwave/contributors),
and pull requests are very welcome. Before submitting a pull request, please make sure that your changes are well tested.
First, make sure you have `imagemagick` and `ghostscript` installed.
Then, you'll need to install bundler and the gem dependencies:
gem install bundler
bundle install
You should now be able to run the local tests:
bundle exec rake
You can also run the remote specs by creating a ~/.fog file:
```yaml
:carrierwave:
:aws_access_key_id: xxx
:aws_secret_access_key: yyy
:rackspace_username: xxx
:rackspace_api_key: yyy
:google_storage_access_key_id: xxx
:google_storage_secret_access_key: yyy
```
You should now be able to run the remote tests:
REMOTE=true bundle exec rake
Please test with the latest Ruby 1.8.x and 1.9.x versions using RVM if possible.
## Running active record tests
Make sure you have a local MySQL database named `carrierwave_test` with the username
`root` and empty password.

37
README.md
View File

@ -737,42 +737,7 @@ This has only been tested with the local filesystem store.
## Contributing to CarrierWave
CarrierWave thrives on a large number of [contributors](https://github.com/jnicklas/carrierwave/contributors),
and pull requests are very welcome. Before submitting a pull request, please make sure that your changes are well tested.
First, make sure you have `imagemagick` and `ghostscript` installed.
Then, you'll need to install bundler and the gem dependencies:
gem install bundler
bundle install
You should now be able to run the local tests:
bundle exec rake
You can also run the remote specs by creating a ~/.fog file:
```yaml
:carrierwave:
:aws_access_key_id: xxx
:aws_secret_access_key: yyy
:rackspace_username: xxx
:rackspace_api_key: yyy
:google_storage_access_key_id: xxx
:google_storage_secret_access_key: yyy
```
You should now be able to run the remote tests:
REMOTE=true bundle exec rake
Please test with the latest Ruby 1.8.x and 1.9.x versions using RVM if possible.
### Running active record tests
Make sure you have a local MySQL database named `carrierwave_test` with the username
`root` and empty password.
See [CONTRIBUTING.md](https://github.com/jnicklas/carrierwave/blob/master/CONTRIBUTING.md)
## License