From 994acf4604ce0d6bc6f76de46bd1c0783d2daba0 Mon Sep 17 00:00:00 2001 From: "Francis Luong (Franco)" Date: Fri, 11 Mar 2016 10:16:33 -0500 Subject: add .idea/ to .gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 85d89b4..9b2dc3e 100644 --- a/.gitignore +++ b/.gitignore @@ -16,3 +16,4 @@ server.rb *.sw? /tmp/ /_yardoc/ +.idea/ \ No newline at end of file -- cgit v1.2.1 From db8cf9752ebce08b7abb94c10eca4bf70c425250 Mon Sep 17 00:00:00 2001 From: "Francis Luong (Franco)" Date: Fri, 11 Mar 2016 10:30:35 -0500 Subject: add contributing draft --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 CONTRIBUTING.md 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. -- cgit v1.2.1