Skip to content
Snippets Groups Projects
Commit 6e3aa7d1 authored by Francis Luong (Franco)'s avatar Francis Luong (Franco)
Browse files

update readme and contributing

parent 336cadd7
No related branches found
No related tags found
No related merge requests found
# Contributing to the IPAddress Gem # Contributing to the IPAddress Gem
[![Build Status](https://travis-ci.org/ipaddress-gem/ipaddress.svg?branch=master)](https://travis-ci.org/ipaddress-gem/ipaddress)[![Code Climate](https://codeclimate.com/github/ipaddress-gem/ipaddress/badges/gpa.svg)](https://codeclimate.com/github/ipaddress-gem/ipaddress)[![Dependency Status](https://www.versioneye.com/user/projects/57001305fcd19a0051853bde/badge.svg?style=flat)](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. 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. 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 ...@@ -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. 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. 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
== <b>IPAddress 1.0 is currently under development and will be released soon! Stay tuned!</b>
---
= IPAddress = IPAddress
IPAddress is a Ruby library designed to make the use of IPv4 and IPv6 IPAddress is a Ruby library designed to make the use of IPv4 and IPv6
...@@ -18,10 +14,13 @@ examples of typical usage. ...@@ -18,10 +14,13 @@ examples of typical usage.
== Requirements == Requirements
* Ruby >= 1.8.7 (not tested with previous versions) * Ruby 1.9.3 or later
* Ruby 1.9.2 or later is strongly recommended
Please refer to {Travis CI}[https://travis-ci.org/ipaddress-gem/ipaddress] for Build Tests on specific versions of Ruby.
{<img src="https://travis-ci.org/ipaddress-gem/ipaddress.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/ipaddress-gem/ipaddress]{<img src="https://codeclimate.com/github/ipaddress-gem/ipaddress/badges/gpa.svg" />}[https://codeclimate.com/github/ipaddress-gem/ipaddress]{<img src="https://www.versioneye.com/user/projects/57001305fcd19a0051853bde/badge.svg?style=flat" alt="Dependency Status" />}[https://www.versioneye.com/user/projects/57001305fcd19a0051853bde]
IPAddress 0.8.2 has been tested on: IPAddress 0.8.2 was manually tested on:
* ruby-1.8.7-p334 [ i386 ] * ruby-1.8.7-p334 [ i386 ]
* ree-1.8.7-2011.03 [ i386 ] * ree-1.8.7-2011.03 [ i386 ]
...@@ -32,9 +31,7 @@ IPAddress 0.8.2 has been tested on: ...@@ -32,9 +31,7 @@ IPAddress 0.8.2 has been tested on:
* ruby-2.0.0-p353 [ x86_64-darwin14.0.0 ] * ruby-2.0.0-p353 [ x86_64-darwin14.0.0 ]
* ruby-2.1.3-p242 [ x86_64-darwin14.0.0 ] * ruby-2.1.3-p242 [ x86_64-darwin14.0.0 ]
If you want to collaborate feel If you want to contribute, please refer to {Contributing.md}[https://github.com/ipaddress-gem/ipaddress/blob/master/CONTRIBUTING.md].
free to send a small report to my email address, or
{join the discussion}[http://groups.google.com/group/ruby-ipaddress].
== Installation == Installation
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment