Merge 21d2234 into 70bce27

.github/ISSUE_TEMPLATE/bug_report.md

@@ -5,10 +5,16 @@ labels:
 
 ---
 
-**Describe the bug**
+### Describe the bug
+
 A clear and concise description of what the bug is.
 
-**To Reproduce**
+### Gem Version Used
+
+v0.1.0
+
+### To Reproduce
+
 Code snippet to reproduce
 ``` ruby
 require 'contextual_logger'
@@ -18,11 +24,14 @@ logger = ContextualLogger.new(Logger.new(STDOUT))
 ...
 ```
 
-**Expected behavior**
+### Expected behavior
+
 A clear and concise description of what you expected to happen.
 
-**Screenshots/Stacktraces**
+### Screenshots/Stacktraces
+
 If applicable, add screenshots and/or stacktraces to help explain your problem.
 
-**Additional context**
+### Additional context
+
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -5,14 +5,18 @@ labels:
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
+### Is your feature request related to a problem? Please describe.
+
 A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 
-**Describe the solution you'd like**
+### Describe the solution you'd like
+
 A clear and concise description of what you want to happen.
 
-**Describe alternatives you've considered**
+### Describe alternatives you've considered
+
 A clear and concise description of any alternative solutions or features you've considered.
 
-**Additional context**
+### Additional context
+
 Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+## \<pull request title\>
+* __Issue Link:__
+
+### Summary of Changes
+This can be a bulleted list or a couple easy to understand sentences.

CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Contributing to ContextualLogger
+
+This document explains our guidelines and workflows to contributing to an Invoca open source project.  Please take care to follow the guidelines, as they exist to help us manage changes in a timely and efficient manner.
+
+## Environment Setup
+1. Install the ruby version specified in the [.ruby-version](https://github.com/Invoca/contextual_logger/blob/master/.ruby-version) file (preferably you're using [rvm](https://rvm.io/) or [rbenv](https://github.com/rbenv/rbenv) to manage ruby versions)
+2. Make a fork of ContextualLogger, then clone your fork to your machine
+3. Run `bundle install` in your ContextualLogger directory to install dependencies
+4. You're ready to go
+
+## Branching
+
+* __Create an issue before starting a branch__
+* For bugs, prefix the branch name with `bug/`
+* For features, prefix the branch name with `feature/`
+* Include the issue number and a short description of the issue
+
+Examples 
+* `bug/1234_fix_issue_with_formatter_not_formatting`
+* `feature/4321_merge_contexts_together`
+
+## Filing Issues
+
+* Use the appropriate template provided
+* Include as much information as possible to help:
+  * The person who will be fixing the bug understand the issue
+  * The person code reviewing the fix to understand what the original need was
+* Check for open issues before filing your own
+
+## Committing
+
+* Break your commits into logical atomic units. Well-segmented commits make it much easier for others to step through your changes.
+* Limit your subject (first) line to 50 characters (GitHub truncates more than 70).
+* Provide a body if you'd like to explain your commit in detail.
+* Capitalize the beginning of your subject line, and do not end the subject line with a period.
+* Your subject line should complete this sentence: `If applied, this commit will [your subject line]`.
+* Don't use [magic GitHub words](https://help.github.com/articles/closing-issues-using-keywords/) in your commits to close issues - do that in the pull request for your code instead.
+* Adapted from [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/#seven-rules).
+
+## Making Pull Requests
+
+* Use fill out the template provided
+* Provide a link to the issue being resolved by the PR
+* Make sure to include tests
+* Resolve linting comments from Hound before requesting review

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Invoca Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -38,3 +38,6 @@ If you'd like to set a global context for your process, you can do the following
 ```ruby
 contextual_logger.global_context = { service_name: 'test_service' }
 ```
+
+## Contributions
+All contributors to this project must adhere to the [Community Code of Conduct](https://github.com/Invoca/contextual_logger/blob/master/code-of-conduct.md)

code-of-conduct.md

@@ -0,0 +1,16 @@
+# Invoca Community Code of Conduct v1.0
+
+## Contributor Code of Conduct
+As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.