Skip to content

Commit 0105573

Browse files
jebentierjebentier
authored
Merge 04f1ab3 into 70bce27 
2 parents 70bce27 + 04f1ab3 commit 0105573

File tree

7 files changed

+135
-13
lines changed

7 files changed

+135
-13
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,24 @@ about: Create a report to help us improve
44
labels:
55

66
---
7+
<!--
8+
If you are reporting a new issue, make sure that we do not have any duplicates
9+
already open. You can ensure this by searching the issue list for this
10+
repository. If there is a duplicate, please close your issue and add a comment
11+
to the existing issue instead.
12+
-->
713

8-
**Describe the bug**
9-
A clear and concise description of what the bug is.
14+
### Bug Description
1015

11-
**To Reproduce**
16+
<!-- A clear and concise description of what the bug is. -->
17+
18+
#### Gem Version Used
19+
20+
<!-- v0.1.0 -->
21+
22+
#### To Reproduce
23+
24+
<!--
1225
Code snippet to reproduce
1326
``` ruby
1427
require 'contextual_logger'
@@ -17,12 +30,16 @@ require 'logger'
1730
logger = ContextualLogger.new(Logger.new(STDOUT))
1831
...
1932
```
33+
-->
34+
35+
#### Expected behavior
36+
37+
<!-- A clear and concise description of what you expected to happen. -->
38+
39+
#### Screenshots/Stacktraces
2040

21-
**Expected behavior**
22-
A clear and concise description of what you expected to happen.
41+
<!-- If applicable, add screenshots and/or stacktraces to help explain your problem. -->
2342

24-
**Screenshots/Stacktraces**
25-
If applicable, add screenshots and/or stacktraces to help explain your problem.
43+
#### Additional context
2644

27-
**Additional context**
28-
Add any other context about the problem here.
45+
<!-- Add any other context about the problem here. -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,26 @@ labels:
55

66
---
77

8-
**Is your feature request related to a problem? Please describe.**
8+
### Is your feature request related to a problem? Please describe.
9+
10+
<!--
911
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
-->
13+
14+
### Describe the solution you'd like
1015

11-
**Describe the solution you'd like**
16+
<!--
1217
A clear and concise description of what you want to happen.
18+
-->
1319

14-
**Describe alternatives you've considered**
20+
### Describe alternatives you've considered
21+
22+
<!--
1523
A clear and concise description of any alternative solutions or features you've considered.
24+
-->
25+
26+
### Additional context
1627

17-
**Additional context**
28+
<!--
1829
Add any other context or screenshots about the feature request here.
30+
-->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## \<pull request title\>
2+
* __Issue Link:__ <!-- Use [magic GitHub words](https://help.github.com/articles/closing-issues-using-keywords/) to link to the issue here -->
3+
4+
### Summary of Changes
5+
<!-- This can be a bulleted list or a couple easy to understand sentences. -->

‎CONTRIBUTING.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing to ContextualLogger
2+
3+
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.
4+
5+
## Code of Conduct
6+
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)
7+
8+
## Environment Setup
9+
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)
10+
2. Make a fork of ContextualLogger, then clone your fork to your machine
11+
3. Run `bundle install` in your ContextualLogger directory to install dependencies
12+
13+
## Branching
14+
15+
* __Create an issue before starting a branch__
16+
* For bugs, prefix the branch name with `bug/`
17+
* For features, prefix the branch name with `feature/`
18+
* Include the issue number and a short description of the issue
19+
20+
Examples
21+
* `bug/1234_fix_issue_with_formatter_not_formatting`
22+
* `feature/4321_merge_contexts_together`
23+
24+
## Filing Issues
25+
26+
* Use the appropriate template provided
27+
* Include as much information as possible to help:
28+
* The person who will be fixing the bug understand the issue
29+
* The person code reviewing the fix to understand what the original need was
30+
* Check for open issues before filing your own
31+
32+
## Committing
33+
34+
* Break your commits into logical atomic units. Well-segmented commits make it much easier for others to step through your changes.
35+
* Limit your subject (first) line to 50 characters (GitHub truncates more than 70).
36+
* Provide a body if you'd like to explain your commit in detail.
37+
* Capitalize the beginning of your subject line, and do not end the subject line with a period.
38+
* Your subject line should complete this sentence: `If applied, this commit will [your subject line]`.
39+
* 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.
40+
* Adapted from [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/#seven-rules).
41+
42+
## Making Pull Requests
43+
44+
* Use fill out the template provided
45+
* Provide a link to the issue being resolved by the PR
46+
* Make sure to include tests
47+
* Resolve linting comments from Hound before requesting review

‎LICENSE‎

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

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,7 @@ If you'd like to set a global context for your process, you can do the following
3838
```ruby
3939
contextual_logger.global_context = { service_name: 'test_service' }
4040
```
41+
42+
## Contributions
43+
44+
Contributions to this project are always welcome. Please thoroughly read our [Contribution Guidelines](https://github.com/Invoca/contextual_logger/blob/master/CONTRIBUTING.md) before starting any work.

‎code-of-conduct.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Invoca Community Code of Conduct v1.0
2+
3+
## Contributor Code of Conduct
4+
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.
5+
6+
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.
7+
8+
Examples of unacceptable behavior by participants include:
9+
* The use of sexualized language or imagery
10+
* Personal attacks
11+
* Trolling or insulting/derogatory comments
12+
* Public or private harassment
13+
* Publishing other's private information, such as physical or electronic addresses, without explicit permission
14+
* Other unethical or unprofessional conduct
15+
16+
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.

0 commit comments

Comments
 (0)