[add:git] Add GitHub issue and pull request templates (#54)

.github/ISSUE_TEMPLATE/error-or-warning.md

@@ -0,0 +1,23 @@
+---
+name: Error or warning
+about: For reporting an error or warning generated by Eucalypt
+labels: error/warning
+---
+
+# Issue title
+
+- **Type**: Error or warning
+- **Operating system**: ...
+- **Ruby version manager (and version)**: e.g. `rbenv` (`1.1.1`)
+- **Ruby version**: ...
+- **Eucalypt version**: ...
+
+Full description of the error or warning, including the error or warning message itself.
+
+​```
+Any error or warning messages should be placed in code blocks.
+​```
+
+## Steps to reproduce
+
+1. Provide the necessary steps to reproduce the warning or error.

.github/ISSUE_TEMPLATE/improvement.md

@@ -0,0 +1,15 @@
+---
+name: Improvement to an existing feature
+about: For suggesting an improvement to a feature already offered by Eucalypt
+labels: improvement
+---
+
+# Issue title
+
+## Existing feature
+
+Description of the current feature, detailing exactly what should be changed and why.
+
+## Improvement
+
+Description of your proposed improvement.

.github/ISSUE_TEMPLATE/new-feature.md

@@ -0,0 +1,9 @@
+---
+name: Suggesting a new feature
+about: For proposing a new feature to Eucalypt that would be beneficial
+labels: feature
+---
+
+# Issue title
+
+Detailed description of your proposed improvement, explaining why it would be a useful feature.

.github/ISSUE_TEMPLATE/unexpected.md

@@ -0,0 +1,21 @@
+---
+name: Unexpected or incorrect functionality
+about: For reporting something that doesn't seem to be working correctly or is unexpected
+labels: unexpected
+---
+
+# Issue title
+
+- **Type**: Unexpected or incorrect functionality
+- **Operating system**: ...
+- **Ruby version manager (and version)**: e.g. `rbenv` (`1.1.1`)
+- **Ruby version**: ...
+- **Eucalypt version**: ...
+
+## Expected functionality
+
+Description of the expected functionality.
+
+## Actual functionality
+
+Description of the actual functionality.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,17 @@
+<!--
+Thanks for contributing to Eucalypt!
+Before you submit your pull request, please make sure to check the following boxes.
+-->
+
+### Checklist
+- [ ] All old and new tests pass (ran `bundle exec rspec spec` in the root directory).
+- [ ] Read the [contribution guidelines](/CONTRIBUTING.md).
+- [ ] Updated documentation (if necessary).
+
+### Reason (or issue)
+<!-- Why is this change required? What problem does it solve? -->
+<!-- If it fixes an open issue, please link to the issue here. -->
+
+### Description
+<!-- Describe your changes in detail -->
+<!-- Please describe in detail how you tested your changes. -->

CONTRIBUTING.md

@@ -1,37 +1,62 @@
-# Contribution guidelines
+# Contributing
 
-## Writing issues
+As Eucalypt is an open source library, any contributions from the community are greatly appreciated. This document details the guidelines for making contributions to Eucalypt.
 
-When writing issues, please make sure to include the following information:
+## Reporting issues
 
-- Operating system (and version)
-- Ruby version
-- Eucalypt version
-- Any relevant stack traces or error messages
+Prior to reporting an issue, please ensure:
 
-Please try to answer the following questions (in as much detail as possible):
+- [ ] You have used the search utility provided on GitHub issues to look for similar issues.
+- [ ] You have checked the documentation (for the version of Eucalypt you are using).
+- [ ] You are using the latest version of Eucalypt (if possible).
 
-- What did you do?
-- What did you expect to happen?
-- What happened instead?
+Issues may be one of four different types listed below. Please use the respective [issue template](/.github/ISSUE_TEMPLATE) when creating an issue:
 
-## Making pull requests
+- **Error or warning** ([template](/.github/ISSUE_TEMPLATE/error-or-warning.md))<br>For reporting an error or warning generated by Eucalypt.
+- **Unexpected or incorrect functionality** ([template](/.github/ISSUE_TEMPLATE/unexpected.md))<br>For reporting something that doesn't seem to be working correctly or is unexpected.
+- **Improvement to an existing feature** ([template](/.github/ISSUE_TEMPLATE/improvement.md))<br>For suggesting an improvement to a feature already offered by Eucalypt.
+- **Suggesting a new feature** ([template](/.github/ISSUE_TEMPLATE/new-feature.md))<br>For proposing a new feature to Eucalypt that would be beneficial.
 
-- **Add specs**: Your patch won't be accepted if it doesn't have any specs.
+## Making changes to Eucalypt
 
-- **Document any change in behaviour**: Make sure the README, GitBook and all other
-  relevant documentation is kept up-to-date.
+- **Add specs**: Your pull request won't be accepted if it doesn't have any specs.
+
+- **Document any change in behaviour**: Make sure the README, GitBook documentation and all other relevant documentation is kept up-to-date.
 
 - **Create topic branches**: Will not pull from your master branch!
 
 - **One pull request per feature**: If you wish to add more than one new feature, please make multiple pull requests.
 
-- **Meaningful commit messages**: Make sure each individual commit in your pull
-  request has a meaningful message.
+- **Meaningful commit messages**: Make sure each individual commit in your pull request has a meaningful message.
+
+- **De-clutter commit history**: If you had to make multiple intermediate commits while developing, please squash them before making your pull request.
+
+### Branch naming conventions
+
+Branch names must be of the form `type/short-phrase-or-description`, where `type` is either a:
+
+- `patch`: Making a change to an existing feature.
+- `add`: Adding a new feature.
+- `rm`: Removal of an existing feature.
+
+Branches should typically feature only one main change. If making multiple unrelated changes, please create separate branches and open separate pull requests.
+
+### Making pull requests
+
+**Ensure you use the [pull request template](/.github/PULL_REQUEST_TEMPLATE.md).**
+
+Pull request titles must be of the form `[type:specifier] Pull request title`, where `type` is the same as the branch type (read above).
+
+The `specifier` should be one of:
+
+- `lib`: Changes to any code in the `lib` directory.
+- `gem`: Changes to any gem related things, such as `eucalypt.gemspec`, `Rakefile` or dependencies.
+- `ci`: Changes to `.travis.yml` or `.coveralls.yml`.
+- `specs`: Changes to any code in the `specs` directory.
+- `git`: Changes to any Git-related code, such as `.gitignore`.
 
-- **Uncluttered commit history**: If you had to make multiple intermediate commits while
-  developing, please squash them before making your pull request.
+Continuous integration (Travis CI) builds must pass in order for your pull request to be merged.
 
 ## License
 
-By contributing, you agree that your contributions will be licensed under the same [MIT License that covers this repository](/LICENSE).
+By contributing, you agree that your contributions will be licensed under the same [MIT License](/LICENSE) that covers this repository.