diff options
| author | Francis Luong (Franco) <franco@definefunk.com> | 2016-05-15 08:04:18 -0400 |
|---|---|---|
| committer | Francis Luong (Franco) <franco@definefunk.com> | 2016-05-15 08:04:18 -0400 |
| commit | 2a10d48ca4b4e42bcbac708473ce73c6dd4e5b15 (patch) | |
| tree | 781d322c2b85d3cebdaf933c860ed306c29734f5 /CONTRIBUTING.md | |
| parent | 74e82ee2d46025f299fb86c66e49bb63b6566292 (diff) | |
| parent | ae8d052e1460de6d6bdd5dc33db600b7ed9e2b49 (diff) | |
| download | ipaddress-2a10d48ca4b4e42bcbac708473ce73c6dd4e5b15.tar.gz | |
Merge pull request #78 from ipaddress-gem/travis-and-jeweler
Add Travis, CodeClimate, and Jeweler
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4ae0398..94f60b5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,7 @@ # Contributing to the IPAddress Gem +[](https://travis-ci.org/ipaddress-gem/ipaddress) [](https://codeclimate.com/github/ipaddress-gem/ipaddress) [](https://www.versioneye.com/user/projects/57001305fcd19a0051853bde) + This gem is run by people who have jobs. So please understand if we can't always prioritize PRs and issues. You can help by making your code submissions. We can't promise a specific turnaround time, or that your code will be incorporated but all submissions are appreciated. @@ -22,3 +24,16 @@ All submissions of code must include test coverage which describes intent and ex Unit tests are expected to execute quickly. We will ask you to revise any long-running tests. We intend to add [Travis CI](https://travis-ci.org/) for automatic execution of branch tests. + +## Versioning: Jeweler and Semantic Versioning + +This repo uses [semantic versioning](http://semver.org/) implemented by the [Jeweler Gem](https://github.com/technicalpickles/jeweler). Please do not update the version by editting files, instead, you may increment or modify the version using the Rake tasks added by Jeweler. + +``` +$ rake -T | grep version +rake version # Displays the current version +rake version:bump:major # Bump the major version by 1 +rake version:bump:minor # Bump the a minor version by 1 +rake version:bump:patch # Bump the patch version by 1 +rake version:write # Writes out an explicit version +```
\ No newline at end of file |