diff options
author | Mike Mackintosh <mikemackintosh@users.noreply.github.com> | 2016-03-16 00:23:57 -0400 |
---|---|---|
committer | Mike Mackintosh <mikemackintosh@users.noreply.github.com> | 2016-03-16 00:23:57 -0400 |
commit | 74e82ee2d46025f299fb86c66e49bb63b6566292 (patch) | |
tree | 2fb8d9ac9888abb2878bb1108e9be0985a5446ae | |
parent | f04db1f70f9888494fc155ca7c06d33f778f9ac0 (diff) | |
parent | 817b20fda4520e2b5272993aa18d9394178f2d33 (diff) | |
download | ipaddress-74e82ee2d46025f299fb86c66e49bb63b6566292.tar.gz |
Merge pull request #73 from francisluong/70-contributing-md
70 contributing md
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | CONTRIBUTING.md | 24 |
2 files changed, 25 insertions, 0 deletions
@@ -17,3 +17,4 @@ server.rb /tmp/ /_yardoc/ .idea/ + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4ae0398 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing to the IPAddress Gem + +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](https://help.github.com/articles/fork-a-repo) the project on GitHub. +* Make your feature addition or bug fix [in a feature branch](https://github.com/Kunena/Kunena-Forum/wiki/Create-a-new-branch-with-git-and-manage-branches). (Include a description of your changes in the PR) +* Push your feature branch to GitHub. +* Send a [Pull Request](https://help.github.com/articles/using-pull-requests) + +## Style Guide + +We will require that you adhere to the [ruby-style-guide](https://github.com/bbatsov/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](https://github.com/seattlerb/minitest) + +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. |