Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

39 lines (25 loc) · 2.33 KB
Raw

Contributing to the IPAddress Gem

Build Status Code Climate Dependency Status

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.

Steps to Submit a Pull Request

  • Fork the project on GitHub.
  • Make your feature addition or bug fix in a feature branch. (Include a description of your changes in the PR)
  • Push your feature branch to GitHub.
  • Send a Pull Request

Style Guide

We will require that you adhere to the ruby-style-guide for your code submissions.

Test Coverage

All submissions of code must include test coverage which describes intent and expected behavior. The test suite used by this gem is Minitest

Unit tests are expected to execute quickly. We will ask you to revise any long-running tests.

We intend to add Travis CI for automatic execution of branch tests.

Versioning: Jeweler and Semantic Versioning

This repo uses semantic versioning implemented by the Jeweler Gem. 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